[BANNER DO PROJETO]
[SUBTÍTULO DO PROJETO]
🚧 Em desenvolvimento 🚀 🚧
Tabela de conteúdos
💻 Sobre o projeto
[DETALHES DO PROJETO]
⚙️ Funcionalidades
[FUNCIONALIDADES]
🎨 Layout
Frontend web
Frontend mobile
🚀 Como executar o projeto
Pré-requisitos
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode
🎲 Rodando o Backend (servidor)
# Clone este repositório
$ git clone https://github.com/[USER]/[REPO].git
# Acesse a pasta do projeto no terminal/cmd
$ cd [REPO]
# Acesse a pasta do projeto do servidor
$ cd server
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm start
# O servidor inciará na porta:PORT - acesse http://localhost:PORT
🎲 Rodando o Frontend (web)
# Clone este repositório
$ git clone https://github.com/[USER]/[REPO].git
# Acesse a pasta do projeto no terminal/cmd
$ cd [REPO]
# Acesse a pasta do projeto da aplicação web
$ cd web
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm start
# O servidor inciará na porta:3000 - acesse http://localhost:3000
🎲 Rodando o Frontend (mobile)
# Clone este repositório
$ git clone https://github.com/[USER]/[REPO].git
# Acesse a pasta do projeto no terminal/cmd
$ cd [REPO]
# Acesse a pasta do projeto da aplicação web
$ cd mobile
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm start
# O servidor inciará na porta:19002 - acesse http://localhost:19002
🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
Backend
Web
Mobile
💪 Como contribuir no projeto
- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações:
git checkout -b my-feature
- Salve as alterações e crie uma mensagem de commit contando o que você fez:
git commit -m "feature: My new feature"
- Envie as suas alterações:
git push origin my-feature
Caso tenha alguma dúvida confira este guia de como contribuir no GitHub
🦸 Autor
📝 Licença
Este projeto esta sobe a licença MIT.
Feito com ❤️ por [SEU NOME] 👋🏽 [Entre em contato!](https://www.linkedin.com/in/[LINKEDIN USER]/)