Project | Technologies | Services Used | Getting Started | How To Use | Features | License
The project proposed in this challenge was to create a user management API Rest using the concepts of clean code, clean architecture and SOLID (SRP, LSP and DIP). It also required all tests to complete successfully and API documentation to be created in Swagger.
This project is a template for a challenge proposed in the NodeJS track of IGNITE (Rocketseat Career Acceleration Program).
The tests were developed by Rocketseat.
This project was developed using these techs:
- GitHub
- Swagger
If you want run this code, you can start cloning the repository using HTTP or SSH key.
-
Open your git
-
Type
git clone -
Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)
-
You can find this HTTP or SSH Key by clicking on
Codeon the top right in this repository
-
Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal
yarn To add the dependencies on the project.
yarn dev Runs the app in the development mode.
Open http://localhost:3333 to view it in the browser.
You can use Insomnia (or other similar tool) to test the application's routes.
Dependencies
Dev Dependencies
- Ts-Node-Dev
- Jest
- SuperTest
3 - Use Insomnia to test the application's routes or run yarn test to test application routes with JEST & SuperTest
4 - You can also access the route containing the project documentation at http://localhost:3333/api-docs/
The main features of the application are:
- Create a user
- Show user profile
- Turn user on admin user
- List all users (only available if user is admin)
This project is under MIT license.
In case of sensitive bugs like security vulnerabilities, please contact deywerson.pereira@gmail.com directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!
Please follow on github and join us! Thanks for visiting me and good coding!
Made with ♥ by Deywerson Pereira