Purpose | Technologies | Run the application | Application routes | License
This project was built with intention to explore node.js internal modules, which means no Express. So, to fulfill this purpose, the most known modules were used! Among them are the 'fs' - (File System) module from node.js that is used to store our data, in the project it's not used any database management system like Postgres, Oracle OR MongoDB!
-
node.js installation https://nodejs.org/en/download/
-
YARN installation https://classic.yarnpkg.com/en/docs/install/
-
Clone project in your PC 💻
-
Open the project with a text editor and run 'yarn' to download the dependencies
-
Postman download https://www.getpostman.com/downloads/
-
Run 'yarn dev' to use the endpoints
GET /projects :Endpoint responsible to read all projectsGET /projects?id=number:Endpoint responsible to retrieve a specific project given itsid
number :Represents theidpassed in the query stringPOST /projects :Endpoint responsible to create a project receiving in the request body the project'stitle
Request body example below
{
"title": "Project 1"
}POST /projects/tasks?id=number:Endpoint responsible to create a task to a specific project given itsid, also its passed through the request body thetaskfor the project
number :Represents theidpassed in the query string
Request body example below
{
"task": "task 1"
}PUT /projects?id=number:Endpoint responsible to update a specific project's title given itsid, also its passed through the request body the new project'stitle
number :Represents theidpassed in the query string
Request body example below
{
"title": "Project 2"
}DELETE /projects?id=number:Endpoint responsible to remove a specific project given itsid.
number :Represents theidpassed in the query string
This project is under the MIT license. See the LICENSE for more information.
Made with ♥ by Gabriel Ferrari Tarallo Ferraz 👋 Get in touch!