Node.js REST API with NestJs

Table of Contents

• Description
• Links
• Stack

Description

An REST API allows to perform CRUD operations with a "fiction" company. The company includes departments and employees. The API includes data validation, database migrations, swagger documentation, unit, integration tests.

Links

https://nodejs-rest-api.innokentii-kozlov.com - API endpoint.

https://nodejs-rest-api.innokentii-kozlov.com/api - API Swagger Documentation.

Stack

• Docker
• Kubernetes
• Argo CD
• GitHub Actions
• TypeScript & NestJs
• Postgres & TypeOrm
• Jest

Getting Started

These instructions show how to run the database and API locally using Docker. Make sure you have Docker and Make installed.

1. Generate TLS certificates

make generate-tls-certificates

2. Start the database

This command starts a PostgreSQL container and runs the initial migrations.

make database-start-local

3. Start the API

make api-start-local

The API will be available at https://localhost:3000 by default.