The Backend application of Find It project.
This application expect a HTTP request from Client Frontend and it returns a JSON with data.
In this application the technologies below was used:
Firstly you can clone by using the command below:
git clone https://github.com/BrunoUemura/findit-backend-node.gitOr download the zip file directly from Github and unzip it.
After, downloading open the project direcotiry and run the following commands:
Make sure to check the environment variables
- To install the dependencies
npm install - To run the database migrations
npx sequelize-cli db:migrate - To run the project
npm run dev
Make sure to check the environment variables For testing environment, it is recomended to use docker.
Run the Dockerize Script in bash.
- To run the dockerize script
npm run docker
Make sure to check the environment variables
- To install the dependencies
npm install - To run the database migrations
npx sequelize-cli db:migrate - To run the project
npm start
In this API we have several endpoints that is used by the frontend application.
To make HTTP request to the endpoints in this API it is necessary to include /api before each route. The following are the routes and basic instructions to use them.
Description: Swagger API documentation.
Method: GET
Endpoint: /api-docs \
Description: Make a registration (create user).
Method: POST
Endpoint: /api/auth/register
Body:
{
"name": "Name Lastname",
"email": "[email protected]",
"password": "your_password"
}Description: Make a login (authenticate user).
Method: POST
Endpoint: /api/auth/login
Body:
{
"email": "[email protected]",
"password": "your_password"
}Description: List all the existing users.
Method: GET
Endpoint: /api/users
Description: List one user by its ID.
Method: GET
Endpoint: /api/users/<user_id>
Description: Update user by ID.
Method: PUT
Endpoint: /api/users/<user_id>
Authorization: Bearer Token eyJhbGciOiJIUzI1NiIs...
Body:
{
"name": "Name Lastname",
"email": "[email protected]",
"location": "City, State",
"phone": "+55 19 99999-9999",
"occupation": "Software Developer",
"about_me": "I am a software engineer with experience in backend using Node.js + Express",
"user_photo": "https://github.com/BrunoUemura.png"
}Description: Delete a user by ID.
Method: DELETE
Endpoint: /api/users/<user_id>
Authorization: Bearer Token eyJhbGciOiJIUzI1NiIs... \
Description: List all the existing services.
Method: GET
Endpoint: /api/services
Description: List a service by its ID.
Method: GET
Endpoint: /api/services/<service_id>
Description: List all the existing services by filter.
Method: GET
Endpoint: /api/services?category=?category=Construction
Endpoint: /api/services?location=?location=Campinas, SP
Description: Create a service passing the following body (Remember to pass an existing user ID in the body).
Method: POST
Endpoint: /api/services/
Authorization: Bearer Token eyJhbGciOiJIUzI1NiIs...
Body:
{
"user_id": "2e0313fb-fe0f-4dfb-a3e1-df0692762973",
"title": "Windows Training",
"category": "IT",
"description": "I need someone to teach me how to use windows 11",
"price": "50",
"location": "Brooklyn, NY"
}Description: Update an existing service passing the following body (Remember to pass the service id in URL).
Method: PUT
Endpoint: /api/services/<service_id>
Authorization: Bearer Token eyJhbGciOiJIUzI1NiIs...
Body:
{
"title": "Windows Training",
"category": "IT",
"description": "I need someone to teach me how to use windows 11",
"price": "50",
"location": "Brooklyn, NY"
}Description: Delete a service by its ID.
Method: DELETE
Endpoint: /api/services/<service_id>
Authorization: Bearer Token eyJhbGciOiJIUzI1NiIs...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent