teilorbarcelos / valoriza

API Node.js course by Rocketseat.

Valoriza

This API was developed in a programming course of NodeJs of the Rocketseat online school, in the Next Level Week event for programmers of all levels.

This API was created with [NodeJs] and, basically, creates a back-end system to answer to a front-end app in other or same server.

The data is all stored in a mySQL database, you can use other server, originally, in the course, was used the little sqlite, but, for learning more, I decided to use a free online server with mysql, I choose the Remote MySQL, fill free to use what you want.

Technology

Here are the technologies used in this project.

• typeorm version ^0.2.36
• reflect-metadata version ^0.1.13
• mysql version ^2.18.1
• jsonwebtoken version ^8.5.1
• express-async-errors version ^3.1.1
• express version ^4.17.1
• cors version ^2.8.5
• class-transformer version ^0.4.0
• bcryptjs version ^2.4.3
• uuid version ^8.3.2

Services Used

• Github
• Heroku
• Remote MySQL

Getting started

You can see this API runing here

But, if you want to run this API by yourself, simply create a mySQL database in any online server like Remote MySQL.

In next, you need to write the app credentials in a file ".env" in the root directory like it:

# .env

TYPE=mysql
HOST=remotemysql.com
DB_PORT=3306
USER_NAME=eKJ242AF5H
DATABASE=eKJ242AF5H
PASSWORD=iVsoDUtm8b
ENVIRONMENT=development

HASH_MD5=d48946382f0b249f659bbf519747fb65

In next, you need to run the migrations with the command "yarn typeorm migration:run" to create the tables in your MySQL, and for last, run "yarn dev" to run the local test server and to test the app locally in "http:localhost:3000".

How to use

• To use this API you will need of a front-end app that was coded to comunnicate with it, you can see one of it here and runing and ready to use here.

Features

• With this API, you can create a place where you and your colleagues of job, can share compliments and thanks, generating a nice feeling of thanks and motivation in the workplace, enjoy, it is free for all.

Links

• Link of deployed application: https://valorize.herokuapp.com/
• Repository: https://github.com/teilorbarcelos/valoriza
  • In case of sensitive bugs like security vulnerabilities, please contact OUR EMAIL directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

Versioning

1.0.0.0

Authors

• TEILOR SOUZA BARCELOS: @teilorbarcelos (https://github.com/teilorbarcelos)

Learn More

You can learn more in the [NodeJs documentation].

To learn Express, check out the [ExpreJs oficial Site].

I hope it help you like it helped me too! Thanks for see it and give a repo star if you like it!

Valorize