BiaChacon / valoriza

API for send compliments of the Next Level Week 6.0 🚀

Valoriza

About • Features • How it works • Tech Stack • Documentation • Authors • License

ℹ️ About

API Restful for send compliments created at RocketSeat Next Level Week 6.0, using stack TypeScript with Node.js.

---

⚙️ Features

• Create User
• Login
• Create Tag
• Create Compliment
• List User Send Compliments
• List User Receive Compliments
• List All Users

---

🛠 Tech Stack

The following tools were used in the construction of the project:

• Node.js
• Express
• TypeORM
• Sqlite3
• Metadata Reflection API
• uuid
• ExpressJS Async Errors
• JSON Web Tokens
• bcrypt.js
• class-transformer

---

🚀 How it works

👉 Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js and Yarn. In addition, it is good to have an editor to work with the code like VSCode.

🏁 Start

# Clone this repository
$ git clone https://github.com/BiaChacon/valoriza.git

# Access the project folder cmd/terminal
$ cd valoriza

🎲 Running the server

# install the dependencies
$ npm install

#Create migrations
$ yarn typeorm migration:run

# Run the application
$ yarn dev

# The server will start at port: 3333 - go to http://localhost:3333

---

🗎 Documentation API

🚀 Postman Collection

---

👩🏽‍💻 Authors

Bia Chacon 💻

---

📝 License

This project is under MIT. See at here LICENSE for more information.

---

README versions

English 🇺🇸 | Portuguese 🇧🇷