/fundamentos-nodejs-course-api

CourseAPI is a developed API used to register and manage courses. This was the first application developed during the first chapter of the NodeJS track from IGNITE (Rocketseat Career Acceleration Program).

Primary LanguageJavaScript

CourseAPI

Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    License

PRs welcome! License


💻 Project

CourseAPI is a developed API used to register and manage courses. This was the first application developed during the first chapter of the NodeJS track from IGNITE (Rocketseat Career Acceleration Program).



🚀 Technologies

This project was developed using these techs:


👨‍🔧 Services Used

  • GitHub

🎮 Getting Started

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 Code on the top right in this repository image

  • 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


📌 How to Use

1 - Open the aplication on your IDE

2 - Run yarn dev on your IDE terminal

3 - Use Insomnia to test the application's routes


🕵 Features

The main features of the application are:

  • Create a list of courses
  • View course list
  • Update a course

📝 License

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