Getting Started • API Endpoints • Collaborators • Contribute
Simple description of what your project do or how to use it.
Here you describe how to run your project locally
Here you list all prerequisites necessary for running your project. For example:
How to clone your project
git clone your-project-url-in-githubUse the application.properties.example as reference to create your configuration file application.properties with your AWS Credentials
aws.region=us-east-1
aws.accessKeyId={YOUR_AWS_KEY_ID}
aws.secretKey={YOUR_AWS_SECRET}How to start your project
cd project-name
npm some-command-to-runHere 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 |
RESPONSE
{
"name": "Fernanda Kipper",
"age": 20,
"email": "[email protected]"
}REQUEST
{
"username": "fernandakipper",
"password": "4444444"
}RESPONSE
{
"token": "OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi"
}Special thank you for all people that contributed for this project.
 Fernanda Kipper |
/i490769.jpeg) Elon Musk |
 Steve Jobs |
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
git clone https://github.com/Fernanda-Kipper/text-editor.gitgit checkout -b feature/NAME- Follow commit patterns
- Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!