Alvarez-P/portfolio-api

API with NestJS using TypeORM, JWT, PostgreSQL & Passport

PORTFOLIO - NESTJS API

API with NestJS using TypeORM, JWT, PostgreSQL & Passport

Getting Started ▶️

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites 📋

• NodeJS y NPM
• Docker y Docker-compose
• NestJS

Set your configuration in a .env file with the values of .env.example file

Installing ⬇️

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Built With 🛠️

1. NodeJS
2. NestJS
3. TypeORM
4. PostgreSQL

Versioning 🚩

We use SemVer for versioning. For the versions available, see the tags on this repository.

Future work 🚀

Contributors 👨‍👨‍👦

• Esteban Alvarez - Initial work - @alvarez98

Credits ⭐

• A template to make good README.md - Base template - PurpleBooth

References 🔗

1. NestJS Documentation
2. TypeORM Documentation

License 📄

This project is licensed under the MIT License - see the LICENSE file for details

Made with ❤️ by Esteban Alvarez