Skip to content

Latest commit

 

History

History
104 lines (72 loc) · 1.38 KB

README.md

File metadata and controls

104 lines (72 loc) · 1.38 KB

Project logo

Praise 💙

ℹ️ Description

It is an compliments API developed in Rocketseat - NLW Together with Typescript, nodeJs, Sqlite and Typeorm!

📉 Installing

After clone it, just run:

yarn install

or

npm install

🖱️ Usage


To run all migrations and create the tables, just run:

yarn typeorm migration:run

or

npm run typeorm migration:run

Undo it with:

yarn typeorm migration:revert 

or

npm run typeorm migration:revert



To run API use:

yarn dev

or

npm run dev



🌠 Features and Requirements

  • You can register an user;
  • You can authenticate the user;
  • You can list users;
  • The user need to be authenticate to give or receive a compliment (JWT);
  • User admin permission role;
  • You can create Tags;
  • You can list tags;
  • You can create a compliment for another user;
  • You can get all compliments a user received;
  • You can get all compliments a user sended;

📚 Covered Concepts

  • Orm - Typeorm;
  • Migrations;
  • Jwt Authentication;
  • 1:1 associations;
  • 1:n associations;
  • SQLite