Valorize Next Level Week 06 Project

Report Bug · Request Feature

Check the official repo at github.com/rocketseat-education/nlw-06-nodejs

This project was develop during NLW 06. It's main objective was to create a simple but complete back-end api while learning about NodeJS, and related technologies. Valorize makes it possible for you to recognize and appreciate your colleagues ♥ through a JWT authentication, type of compliment using tags, and finally you can send a compliment with a tag and message to another registered user.
Apart from all of that features I have added Sentry for capture and report errors, and the Swagger UI for easier tests and endpoints documentation.

NLW is a brazilian event created by Rocket Seat in which you can learn a lot and deep dive into your chosen topic, and everything for free! I recommend this event for anyone that speaks Portuguese and want to learn tech, read more in nextlevelweek.com.

Yes I did copy this from the package.json

• TypeScript
• NodeJS
• Express
• TypeORM
• Sentry
• Swagger UI
• SQLite
• bcryptjs
• jsonwebtoken

To get a local copy up and running follow these simple steps.

You must have a Sentry account, after creating your account you will set up an express project inside sentry, their tutorial is really straightforward to follow.

NPM and Yarn are also needed in to run the api.

• yarn

  npm install --global yarn

1. Clone the repo

   git clone https://github.com/lsglucas/valorize.git
   cd valorize

2. Install NPM packages

   yarn install

3. Run development server

   yarn dev

You must have a .env file in the root directory to run this api.
The file must contain two values: SENTRY_DSN with your own sentry's DSN url, and SECRET_TOKEN_KEY with any MD5Hash for JWT

• .env example

  SENTRY_DSN=https://[email protected]/0
  SECRET_TOKEN_KEY=MD5Hash

After running the development server you just need to open the Swagger UI, every possible (in progress) request and required params, etc are documented there.
Once the server is online you just need to open localhost:3000/docs/ and there will have the available routes and you can test it as well.

See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Lucas Garcia - @lsglucass - [email protected]

Project Link: https://github.com/lsglucas/valorize

I would like to thank everyone at Rocket Seat team for this amazing event, It's crazy the amount of knowledge you can obtain in less than a week of learning with this amazing team, I really appreciate you guys for doing this event and helping so many brazilians developers, and people that want to get into tech industry, special thanks to Daniele, Elias Gabriel and everyone at Rocket Seat! We barely finished, and I'm already looking forward for the next event!!

Official repo at github.com/rocketseat-education/nlw-06-nodejs