README.md

api.games.alexgalhardo.com

Introduction

• A side project I created to learn and improve my skills about how to develop a backend for a micro-saas.

Technologies

• NodeJS
• NestJS
• PrismaORM
• Docker
• PostgreSQL

FrontEnd & Docs

• FrontEnd Source Code: https://github.com/AlexGalhardo/games.alexgalhardo.com
• Documentation Source code: https://github.com/AlexGalhardo/docs.games.alexgalhardo.com
• Docs Live: https://docs.games.alexgalhardo.com
• Legacy v1: https://github.com/AlexGalhardo/legacy.api.nerdapi.com

Features

• CRUD API REST
• Authentication (Email & Password, Google & Github)
• Send Emails
• Subscriptions Payments with Webhooks
• Unit Tests using Jest Mocks
• Git Hooks using Husky (pre-commit and pre-push)
• Following clean architecture principles (use-case, repositories, dependency injection, IoC, etc)
• CI/CD using Github Actions (linter, tests, build)
• Middlewares to verify authentication & authorization
• Migrations & Seeds & Database GUI
• OpenAPI Specification Swagger v3 Documentation
• Multi tenant (single database, shared schema)
• Logs & Monitoring
• Zod validation for payload requests
• Security configs (rate-limiter, cors, exception errors handlers, etc)
• Git tags for releases
• Integration tests
• Healthcheck endpoint (databases conections, memory usage, etc)

Development Setup Local

1. Clone repository

git clone [email protected]:AlexGalhardo/api.games.alexgalhardo.com.git

2. Enter repository

cd api.games.alexgalhardo.com/

3. Install dependencies

npm install

4. Setup your environment variables

cp .env.example .env

• Generating JWE Public and Private Keys:
  • Install Bun: https://bun.sh/
  • Run command: npm run generate:jwe:keys

5. Create Migrations and Seeds

chmod +x setup.sh && ./setup.sh

6. To Start Prisma Studio:

npm run prisma:studio

7. Start local server

npm run dev

Build

a. Creating build

npm run build

b. Testing build server locally

npm run start

Tests

a. Run all unit tests

npm run test

Error Logs

• If you wanna use Errosole, enable ENABLE_ERRSOLE=true on your .env file
• Then, you can see Errsole Web Dashboard on http://localhost:3000/errsole

API Requests

• You can see the HTTP Requests references inside folder rest-client/
• You can also see API documentation in:
  • Localhost: http://localhost:3000/docs
  • Live: https://api.games.alexgalhardo.com/docs

Documentation

• Read and add usefull documentation (markdown, notes, images, best practices, etc) about this project inside folder docs/

License

MIT

Copyright (c) August 2023-present, Alex Galhardo