README
¶
Titulo ou Arte do Projeto
Status do Projeto: ✔ ⚠ (concluido, em desenvolvimento, etc)
Tópicos
...
Insira os tópicos do README em links para facilitar a navegação do leitor
Descrição do projeto
Descrição breve do projeto compondo um paragrafo ou dois.
Funcionalidades
✔ Funcionalidade 1
✔ Funcionalidade 2
✔ Funcionalidade 3
✔ Funcionalidade 4
Layout ou Deploy da Aplicação 💨
Link do deploy da aplicação.
...
Se ainda não houver deploy, insira capturas de tela da aplicação ou gifs
Pré-requisitos
⚠ Node
...
Liste todas as dependencias e libs que o usuário deve ter instalado na máquina antes de rodar a aplicação
Como rodar a aplicação ▶
No terminal, clone o projeto:
git clone https ou ssh do projeto
Go
Projeto com Golang
Iniciar servidor
go run main.go
Localhost
Variavel de ambiente Go
GOPATH= export PATH=$PATH:/usr/local/go/bin export PATH=$PATH:/Users/davifernande/go/bin
...
Coloque um passo a passo para rodar a sua aplicação. Dica: clone o próprio projeto e verfique se o passo a passo funciona
Como rodar os testes
Coloque um passo a passo para executar os testes
$ npm test, rspec, etc
Casos de Uso
Explique com mais detalhes como a sua aplicação poderia ser utilizada. O uso de gifs aqui seria bem interessante.
Exemplo: Caso a sua aplicação tenha alguma funcionalidade de login apresente neste tópico os dados necessários para acessá-la.
JSON 💾
Usuários:
| name | password | token | avatar | |
|---|---|---|---|---|
| David Alexandre | [email protected] | davidalexandre93 | true | https://avatars.githubusercontent.com/u/38826514?s=400&u=8c88ded33bb7f95ac76772a892ba2ffebc6bb120&v=4 |
...
Se quiser, coloque uma amostra do banco de dados
Iniciando/Configurando banco de dados
Se for necessário configurar algo antes de iniciar o banco de dados insira os comandos a serem executados
Linguagens, dependencias e libs utilizadas 📚
...
Liste as tecnologias utilizadas no projeto que não forem reconhecidas pelo Github
Resolvendo Problemas ❗
Em issues foram abertos alguns problemas gerados durante o desenvolvimento desse projeto e como foram resolvidos.
Tarefas em aberto
Se for o caso, liste tarefas/funcionalidades que ainda precisam ser implementadas na sua aplicação
📝 Tarefa 1
📝 Tarefa 2
📝 Tarefa 3
Desenvolvedores/Contribuintes :octocat:
Liste o time responsável pelo desenvolvimento do projeto
|
David Alexandre |
| :---: | :---: | :---:
Licença
The MIT License (MIT)
Copyright © Ano - Titulo do Projeto
Directories