Application developed in the sixth edition of Rocketseat Next Level Week π»π
About β’ Technologies β’ Usage β’ Contribution β’ Author β’ License
Valoriza is a platform to promote recognition among teammates.
The following tools were used in the construction of the project:
Required! Install git, node and yarn (or npm).
# Clone Repository
$ git clone https://github.com/RodrigoSaantos/nlw-valoriza.git
# Go to server folder
$ cd nlw-valoriza
# Install Dependencies
$ yarn
# or
$ npm install
# Run Aplication
$ yarn start
# or
$ npm run start
# Access localhost
http://localhost:3000
- POST
/tags
-> Create new tag/users
-> Create new user/login
-> User authenticated/compliments
-> Create compliments (admin)
- GET
/tags
-> List all tags/users
-> List all users/users/compliments/send
-> List send compliments/users/compliments/receive
-> List receive compliments
-
Create User
-
It is not allowed to register more than one user with the same email
-
It is not allowed to register user without e-mail
-
-
Create TAG
-
It is not allowed to register an unnamed tag
-
It is not allowed to register more than one tag with the same name
-
Registration by users who are not administrators is not allowed
-
-
Create Compliments
-
Users are not allowed to register a compliment for themselves
-
It is not allowed to register compliments for invalid users
-
The user must be authenticated in the application
-
POST /session
Request body:
{
"email": "contato.rodrigosaantos@gmail.com",
"password": "12345678"
}
POST /users
Request body:
{
"name": "Rodrigo",
"email": "contato.rodrigosaantos@gmail.com",
"password": "12345678",
"admin": true
}
POST /tags
Request body:
{
"name": "Leader",
}
POST /compliment
Request body:
{
"tag_id": "sa78a97s-d8a0-8c783-382g-382sk92ja873",
"receiver_id": "sui78e7sd-a87l-107l-2znk-19so7uj4hs73",
"message": "You are great leader"
}
This project is for study purposes too. All kinds of contributions are very welcome and appreciated!
- Fork this repository;
- Create a branch with your feature:
git checkout -b my-feature
; - Commit your changes:
git commit -m 'feat: My new feature'
; - Push to your branch:
git push origin my-feature
.
By Rodrigo Santos ππ½ Find me:
This project is under the MIT license.