Skip to content

Latest commit

 

History

History
143 lines (109 loc) · 3.68 KB

backend.md

File metadata and controls

143 lines (109 loc) · 3.68 KB
Raw

Project name 💻

Technologies • Getting Started • API Endpoints • Collaborators • Contribute

Simple description of what your project do or how to use it.

💻 Technologies

  • list of all technologies you used
  • Java
  • MongoDB
  • NodeJS

🚀 Getting started

Here you describe how to run your project locally

Prerequisites

Here you list all prerequisites necessary for running your project. For example:

Cloning

How to clone your project

git clone your-project-url-in-github

Config .env variables

Use the .env.example as reference to create your configuration file .env with your AWS Credentials

NODE_AWS_REGION=us-east-1
NODE_AWS_KEY_ID={YOUR_AWS_KEY_ID}
NODE_AWS_SECRET={YOUR_AWS_SECRET}

Starting

How to start your project

cd project-name
npm some-command-to-run

📍 API Endpoints

Here you can list the main routes of your API, and what are their expected request bodies. ​

route description
GET /authenticate retrieves user info see response details
POST /authenticate authenticate user into the api see request details

GET /authenticate

RESPONSE

{
  "name": "Fernanda Kipper",
  "age": 20,
  "email": "[email protected]"
}

POST /authenticate

REQUEST

{
  "username": "fernandakipper",
  "password": "4444444"
}

RESPONSE

{
  "token": "OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi"
}

🤝 Collaborators

Special thank you for all people that contributed for this project.

Fernanda Kipper Profile Picture
Fernanda Kipper 		Elon Musk Picture
Elon Musk 		Foto do Steve Jobs
Steve Jobs

📫 Contribute

Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request

  1. git clone https://github.com/Fernanda-Kipper/text-editor.git
  2. git checkout -b feature/NAME
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern