ScienceWings is a multitenant and multilanguage resource-sharing marketplace. This repository contains the backend API, responsible for handling authentication, resource management, and API communication.

It leverages Keycloak for authentication, PostgreSQL for data storage, and OpenAPI (Swagger) for automatic API documentation and client generation.

ScienceWings follows a modular, layered architecture to ensure scalability, maintainability, and separation of concerns.

Each domain (such as organizations, resources, users) is treated as a separate module, containing its own data access layer, business logic, and API routes.

Example: The Organizations Module (src/server/modules/organizations/):

/src/server/modules/organizations/
│── daos/            # Data access layer (database queries)
│── dtos/            # Data transfer objects (request/response validation)
│── interfaces/      # TypeScript interfaces for type safety
│── models/          # ORM models (database schema definitions)
│── routes/          # API endpoints for the module
│── schemas/         # Database schema definitions
│── services/        # Business logic for the module
│── index.ts         # Entry point for the module
│── organizationtypes.ts # Enum/constants related to organizations

ScienceWings API is structured into four primary layers:

1️⃣ Controllers (Routes):

• Handles HTTP requests and calls the corresponding service methods.
• Example: src/server/modules/organizations/routes/organizationRoutes.ts

2️⃣ Services (Business Logic):

• Implements core functionality and interacts with DAOs.
• Example: src/server/modules/organizations/services/organizationService.ts

3️⃣ DAOs (Data Access Layer):

• Responsible for database operations (CRUD).
• Example: src/server/modules/organizations/daos/organizationDao.ts

4️⃣ Models & Schemas (Data Layer):

• Defines PostgreSQL tables using MikroORM.
• Example: src/server/modules/organizations/models/organizationModel.ts

This modular approach allows for scalability, easier maintenance, and independent testing of each module.

✅ Multitenant architecture – Supports multiple organizations with isolated data.
✅ Multilanguage support – Built-in localization with i18n.
✅ Keycloak Authentication – Secure login and authorization.
✅ Swagger Documentation – Auto-generated API docs using OpenAPI.
✅ MikroORM – Object-Relational Mapping for PostgreSQL.
✅ Docker Support – Easily deploy the backend with docker-compose.
✅ Permission System – Fine-grained RBAC for access control.

1. Clone the repository

   git clone git@bitbucket.org:science-wings/api.git
   cd sciencewings-api

2. Create an SSH key for Bitbucket (if required)

   ssh-keygen -t rsa -b 4096 -C "your-email@example.com"

3. Switch to the development branch

   git checkout dev

4. Copy the example environment file and configure it

   cp .example.env .env

Run the following commands to start the backend:

npm run init
npm run watch
npm run swagger-gen
npm run start-local-containers
npm run dev
npm run permission-seed

Once the backend is running, access the API documentation:

• Check server health: GET /health
• Swagger API Documentation: http://localhost:3000/api/docs/

ScienceWings integrates Keycloak for authentication and access control. The authentication flow works as follows:

1. The frontend redirects users to Keycloak for login.
2. After successful login, Keycloak provides an access token.
3. The frontend uses this token to authenticate API requests.
4. The backend verifies the token before processing the request.

This ensures secure resource sharing while maintaining role-based access control (RBAC) within an organization.

sequenceDiagram
    participant User
    participant Frontend
    participant Keycloak
    participant API
    participant PostgreSQL

    User ->> Frontend: Submit API request
    Frontend ->> Keycloak: Authenticate user
    Keycloak -->> Frontend: Return access token
    Frontend ->> API: Send request with access token
    API ->> Keycloak: Validate token
    Keycloak -->> API: Token valid
    API ->> PostgreSQL: Fetch or update data
    PostgreSQL -->> API: Return data
    API -->> Frontend: Return response
    Frontend -->> User: Display results

This project is licensed under the GPLv3. See LICENSE.md for details.

• Node.js Documentation
• Keycloak Documentation
• OpenAPI Generator
• Swagger Docs
• PostgreSQL Docs
• Docker Documentation

For further assistance, run:

npm help