An open API service indexing awesome lists of open source software.

https://github.com/than-dev/praise

Praise is an API developed with typescript, nodejs, sqlite and typeorm. In it you can give compliments for another users!
https://github.com/than-dev/praise

api backend compliments jwt nodejs sqlite typeorm typescript

Last synced: 4 months ago
JSON representation

Praise is an API developed with typescript, nodejs, sqlite and typeorm. In it you can give compliments for another users!

Awesome Lists containing this project

README

          



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