frontend.md

Project name 💻

About • Getting Started • App Routes • Collaborators • Contribute

📌 About

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

🚀 Getting started

Here you describe how to run your project locally

Prerequisites

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

• NodeJS
• Git 2

Cloning

How to clone your project

git clone your-project-url-in-github

Starting

How to start your project

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

📍 Application Routes

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

route	description
/authenticate	page that list all user info
/login	page to login
/dashboard	page that contains all user shopping and spences info

🤝 Collaborators

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

Fernanda Kipper

Elon Musk

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