BEE-VEGGIE

Bee Veggie é uma plataforma criada para ajudar na experiência do cliente em um restaurante em meio à pandemia. Desenvolvido com Next.js, Javascript, Material-UI e Axios para o lado Client; E para o lado Sever, Node.js, Koa, Nodemon e Socket.io.

💛 Ajustes e melhorias

O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:

• Projeto inicializado
• Logotipo no Canva
• Paleta de cores:
• Yellow Orange #E1B254
• Black Coffee #3E3433
• Pale Purple #EFE4F1
• Protótipo no Figma
• Server
• Client
• Criação de requests da API
• Views
• Componentes e eventos
• Projeto Finalizado

🌻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• Você instalou a versão mais recente de <Javascript / Node.js / Yarn / Next.js>.
• Você adicionou as seguintes bibliotecas <Material-UI / Koa / Cors do Koa / Nodemon / Socket.io>.
• Você leu o <passo_a_passo_de_intalação_do_projeto>.

🐝 Instalando Bee Veggie

Para instalar o Bee Veggie, siga estas etapas:

Caso não possua o Yarn, instale o Node.js em seu site oficial:

Node.js

e:

<npm install --global yarn>

Clone o projeto:

<git clone https://github.com/danielafarias/Bee-Veggie.git>

Em seguida, adicione as bibliotecas e dependências necessárias no Client Side:

<cd Bee-Veggie>

<cd Client>

<yarn install>

<yarn add next react react-dom>

<yarn add socket.io-client>

<yarn add uuid>

<yarn add @material-ui/core>

<yarn add @material-ui/icons>

<yarn add @material-ui/lab>

E também, adicione as bibliotecas e dependências necessárias no Server Side:

<cd ..>

<cd Server>

<npm i socket.io>

<npm i koa>

<npm i -D nodemon>

<npm i @koa/cors>

🍯 Usando Bee Veggie

Para usar Bee Veggie:

Começe inicializando o /Server:

<nodemon server>

Em seguida inicialize o /Client:

<yarn dev>

Voilà!

http://localhost:3000

🌱 Contribuindo para Bee Veggie

Para contribuir com Bee Veggie, siga estas etapas:

1. Bifurque este repositório.
2. Crie um branch: git checkout -b <bee_seu_nome>.
3. Faça suas alterações e confirme-as: git commit -m '<sua_mensagem_de_commit>'
4. Envie para o branch original: git push origin <master> / <https://github.com/danielafarias/Bee-Veggie>
5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🥬 Colaboradores

Seguintes pessoas que contribuíram para este projeto:

Daniela Farias

Devio

📝 Licença

Esse projeto está sob licença MIT ⚖️. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo

© README.md template by iuricode