/grid-sync-api

API for grid sync app

Primary LanguageTypeScript

Description

Grid Sync API is a NestJS application that provides a REST API for the Grid Sync application.

Features

  • CRUD Endpoint for batteries
  • Database seeder scripts
  • Pagination, filtering and sorting on every on all properties
  • Dockerized application
  • Rate limiting
  • Caching common requests
  • Automated deployment upon merge to master
  • Automated docs generation
  • Swagger UI for API documentation
  • Automated testing upon merge to master
  • Automated code formatting linting on push
  • Automated docker image building and publishing
  • Convenient commit messages using commitizen.

Tech Stack

  • NestJS
  • TypeScript
  • MongoDB
  • Docker
  • Prisma
  • GitHub Actions
  • GitHub Pages

Installation

$ pnpm install

Development

$ pnpm run start:dev

Deployment

$ pnpm run start:prod

Test

# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:cov