https://github.com/cyrusssschen/yellowbox-api
A simple RESTful API for booking smart lockers built in NestJS
https://github.com/cyrusssschen/yellowbox-api
nestjs nx-workspace rest-api
Last synced: 2 months ago
JSON representation
A simple RESTful API for booking smart lockers built in NestJS
- Host: GitHub
- URL: https://github.com/cyrusssschen/yellowbox-api
- Owner: cyrusssschen
- License: mit
- Created: 2024-10-16T07:44:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T04:20:06.000Z (over 1 year ago)
- Last Synced: 2025-04-03T10:29:37.622Z (over 1 year ago)
- Topics: nestjs, nx-workspace, rest-api
- Language: TypeScript
- Homepage:
- Size: 1.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yellowbox-api
**yellowbox-api is a monorepo built on top of [NestJS](https://nestjs.com/) by using [NX](https://nx.dev/) in [microservices](https://microservices.io/) pattern.**
# Prerequisites
Recommend the following installation:
- Install the latest version of Node/NPM ([NVM recommended](https://github.com/nvm-sh/nvm))
- Install [YARN](https://classic.yarnpkg.com/lang/en/)
## Env Variables
1. Simply copy `.env.example` file located in each folder and rename it as `.env` file.
2. Grab the appropriate private key and key ID from your firebase admin page and replace it in each `.env` file
## Build
build all 3 microservices from root folder using the follow commands
```bash
yarn install
yarn build:all
```
# Run
To `run` all 3 microservices, run this nx command in root folder:
```bash
yarn start:all
```
To run the specific service, run this command:
```bash
yarn start:booking
```
# Test
## Unit Tests
To test all microservices, run this command in root folder:
```bash
yarn test:all
```
## E2E Tests
T.B.D.
# Nx Graph
To show Nx Graph
```bash
yarn build:graph
```