https://github.com/astrobookings/system_api

NestJS API that handles, authorization, synchronization and system-wide logs operations for AstroBookings
https://github.com/astrobookings/system_api

api nestjs

Last synced: about 20 hours ago
JSON representation

NestJS API that handles, authorization, synchronization and system-wide logs operations for AstroBookings

• Host: GitHub
• URL: https://github.com/astrobookings/system_api
• Owner: AstroBookings
• Created: 2024-08-26T11:23:15.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T14:22:33.000Z (4 months ago)
• Last Synced: 2024-11-15T14:14:05.397Z (2 months ago)
• Topics: api, nestjs
• Language: TypeScript
• Homepage: https://github.com/AstroBookings
• Size: 324 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🚀 AstroBookings : 🧑‍💼 System API

## [🚀 AstroBookings](https://github.com/AstroBookings)

> A sample project for teaching full-stack development with modern technology and proven best practices.

> 📋 [0. Project Summary Briefing](https://github.com/AstroBookings/.github/blob/main/profile/0-project.briefing.md)

> 📋 [2. System Architecture](https://github.com/AstroBookings/.github/blob/main/profile/2-design/2-system.architecture.md)

> 📋 [3. Model ERD](https://github.com/AstroBookings/.github/blob/main/profile/2-design/3-model.erd.md)

## 🧑‍💼 System API

> [Repository](https://github.com/AstroBookings/system_api)

Central API for authentication, authorization, and system-wide operations. It manages user sessions, handles access control, and provides interfaces for system monitoring and management.

Developed using NestJS with TypeScript for robust type checking, maintainability, and scalable architecture.

### Implemented domains

- [x] [Authentication Domain API](./docs/6_0-authentication.api.md)

- [ ] Data Synchronization Domain API

- [ ] System Monitoring Domain API

#### ⬇️ Consumes:

- [`📇 SystemDB`](https://github.com/AstroBookings/.github/blob/main/profile/3-implementation/5_0-system.schema.md): For user authentication and system logs

- [`📇 OperationsDB`](https://github.com/AstroBookings/.github/blob/main/profile/3-implementation/5_1-operations.schema.md): For system-wide operational data

- [`📇 CacheDB`](https://github.com/AstroBookings/.github/blob/main/profile/3-implementation/5_2-cache.schema.md): For quick access to frequently used data

#### ⬆️ Provides for:

- All Web Applications: Authentication and authorization services

- Other APIs: Central authentication and system management services

## 📚 Repository Instructions

To **run** the project, follow these steps:

```shell

# clone the project

git clone https://github.com/AstroBookings/system_api.git

cd system_api

# install the dependencies

npm install

# run the project

npm run start

# open at http://localhost:3000/authentication/test

```

To **test** the project, follow these steps:

```shell

# run the tests

npm run test

# run the tests in e2e mode

npm run test:e2e

```

To **develop** the project, follow these steps:

```shell

# run the project in watch mode

npm run start:dev

# run the tests in watch mode

npm run test:watch

```

---

## [🚀 AstroBookings](https://github.com/AstroBookings)

> [!NOTE]

>

> > _[Alberto Basalo](https://github.com/albertobasalo)_ >> _Elevating Code Quality._