https://github.com/fazers/portfolio-api
NestJS REST API. Monolithic Backend.
https://github.com/fazers/portfolio-api
backend monolithic nestjs nodejs portfolio rest-api
Last synced: 12 months ago
JSON representation
NestJS REST API. Monolithic Backend.
- Host: GitHub
- URL: https://github.com/fazers/portfolio-api
- Owner: FaZeRs
- License: mit
- Created: 2022-08-22T19:09:45.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T21:23:43.000Z (over 3 years ago)
- Last Synced: 2025-01-31T19:42:41.320Z (over 1 year ago)
- Topics: backend, monolithic, nestjs, nodejs, portfolio, rest-api
- Language: TypeScript
- Homepage: https://api.naurislinde.dev
- Size: 1.36 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Portfolio API
[](https://opensource.org/licenses/MIT)
[](https://sonarcloud.io/dashboard?id=FaZeRs_portfolio-api)
[](https://sonarcloud.io/dashboard?id=FaZeRs_portfolio-api)
[](https://sonarcloud.io/dashboard?id=FaZeRs_portfolio-api)
| Repository | Info |
| -------------------------------------------------------------- | ------------------ |
| [portfolio-client](https://github.com/FaZeRs/portfolio-client) | Frontend |
| [portfolio-api](https://github.com/FaZeRs/portfolio-api) | Rest API |
| [portfolio-server](https://github.com/FaZeRs/portfolio-server) | Docker Environment |
## Features
| Feature | Info |
| ------------------------ | --------------------------------------------------------------- |
| Authentication | [JWT](https://github.com/auth0/node-jsonwebtoken) |
| Authorization | RBAC (Role based) |
| ORM Integration | [TypeORM](https://github.com/typeorm/typeorm) |
| DB Migrations | [TypeORM](https://github.com/typeorm/typeorm) |
| Logging | [winston](https://github.com/winstonjs/winston) |
| Request Validation | [class-validator](https://github.com/typestack/class-validator) |
| Pagination | SQL offset & limit |
| Docker Ready | [Dockerfile](https://www.docker.com/) |
| Auto-generated OpenAPI | - |
| Auto-generated ChangeLog | [Release Please](https://github.com/googleapis/release-please) |
| Queue | [Bull](https://github.com/OptimalBits/bull) |
| File System | [Minio](https://github.com/minio/minio) |
| Mailing | [Nodemailer](https://github.com/nodemailer/nodemailer) |
## Installation
Note: when using docker, all the `pnpm` commands can also be performed using `./scripts/pnpm` (for example `./scripts/pnpm install`).
This script allows you to run the same commands inside the same environment and versions than the service, without relying on what is installed on the host.
```bash
$ pnpm install
```
Create a `.env` file from the template `.env.template` file.
```bash
cp .env.template .env
```
Generate public and private key pair for jwt authentication:
### With docker
Run this command:
```bash
./scripts/generate-jwt-keys
```
It will output something like this. You only need to add it to your `.env` file.
```
To setup the JWT keys, please add the following values to your .env file:
JWT_PUBLIC_KEY_BASE64="(long base64 content)"
JWT_PRIVATE_KEY_BASE64="(long base64 content)"
```
### Without docker
```bash
$ ssh-keygen -t rsa -b 2048 -m PEM -f jwtRS256.key
# Don't add passphrase
$ openssl rsa -in jwtRS256.key -pubout -outform PEM -out jwtRS256.key.pub
```
You may save these key files in `./local` directory as it is ignored in git.
Encode keys to base64:
```bash
$ base64 -i local/jwtRS256.key
$ base64 -i local/jwtRS256.key.pub
```
Must enter the base64 of the key files in `.env`:
```bash
JWT_PUBLIC_KEY_BASE64=BASE64_OF_JWT_PUBLIC_KEY
JWT_PRIVATE_KEY_BASE64=BASE64_OF_JWT_PRIVATE_KEY
```
## Running the app
We can run the project with or without docker.
### Local
To run the server without Docker we need this pre-requisite:
- PostgreSQL server running
- Redis server running
- Minio server running
Commands:
```bash
# development
$ pnpm start
# watch mode
$ pnpm start:dev
# production mode
$ pnpm start:prod
```
### Docker
```bash
# build image
$ docker build -t portfolio-api .
# run container from image
$ docker run -p 3000:3000 --volume 'pwd':/usr/src/app --network="bridge" --env-file .env portfolio-api
# run using docker compose
$ docker compose up
```
## Test
```bash
# unit tests
$ pnpm test
# e2e tests
$ pnpm test:e2e
# test coverage
$ pnpm test:cov
```
## Migrations
```bash
# generate migration (replace CreateUsers with name of the migration)
$ pnpm migration:generate -- -n CreateUsers
# run migration
$ pnpm migration:run
# revert migration
$ pnpm migration:revert
```
## Architecture
- [Project Structure](./docs/project-structure.md)