1 - Um parágrafo descrevendo o projeto, aqui dá para colocar uma imagem ou logo! :)
2 - Coloque aqui o link do projeto em produção!
3 - Lista com as funcionalidades:
- Funcionalidade tal
- Funcionalidade Y
Coloque aqui todos os comandos que a pessoa precisa usar para poder rodar o projeto, por exemplo:
After you have cloned this repo, install the dependencies with:
yarn install
Before you run this application, you need to run the server:
yarn server
(if you never used json server, install it globaly with
yarn globall add json-server
)
Then you can then start the application running:
yarn start
That's it. Just Access http://localhost:3000
in your browser.
Se tiver testes, explicar como executar os testes para este sistema e colocar o comando. Ex:
If you want to run all tests, you can run:
yarn test
Mencione as ferramentas que você usou para criar seu projeto
- React
- CSS
- HTML
E com as bibliotecas:
- Aplicar tema light/dark
- Criar página de contato
- 75% de cobertura de testes
Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início
- Nome do dev - Função
- Nome do dev - Função
Agradeça quem te ajudou a fazer esse projeto! :)
Template por Adriana Saty