🥣 GoRestaurant

🥣 App web/mobile de cardápio para restaurante que permite criar, atualizar e remover pratos, além de fazer pedidos 🍽️

Concluído 🚀

Tabela de conteúdos

• Sobre o projeto
• Funcionalidades
• Layout
  • Web
  • Mobile
• Como executar o projeto
  • Pré-requisitos
  • Rodando a fake API
  • Rodando a aplicação web (Frontend)
  • Rodando a aplicação mobile (Frontend)
• Tecnologias
  • Website
  • Mobile
  • Utilitários
• Como contribuir no projeto
• Autor
• Licença

💻 Sobre o projeto

🥣 O GoRestaurant é um app de cardápio para restaurante com interface para web que permite a criação, remoção e atualização de pratos de comida, e interface mobile que permite a realização de pedidos e escolha de pratos favoritos.

Projeto desenvolvido durante o bootcamp GoStack oferecido pela Rocketseat.

---

⚙️ Funcionalidades

• Restaurantes podem utilizar a plataforma web para:
  • Cadastrar novos pratos
  • Editar pratos
  • Listar os pratos
  • Remover pratos
  • Alterar a disponibilidade dos pratos
• Os usuários tem acesso ao app mobile, onde podem:
  • Listar os pratos de comida e categorias
  • Filtrar pratos de comida por busca ou por categorias
  • Listar seus pratos favoritos
  • Realizar um pedido

---

🎨 Layout

O layout da aplicação está disponível no Figma:

Web

Mobile

---

🚀 Como executar o projeto

Este projeto é divido em duas partes:

1. Frontend Web (pasta web)
2. Frontend Mobile (pasta mobile)

💡 Tanto o Frontend Web quanto o Mobile utilizam uma fake API que roda na porta 3333

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 a fake API

# Clone este repositório
$ git clone git@github.com:lucasbarzan/gorestaurant.git

# Acesse a pasta do projeto no terminal/cmd
$ cd gorestaurant

# Vá para a pasta do frontend
$ cd web

# Instale as dependências
$ npm install

# Execute o script da fake API
$ npm run json-server server.json -p 3333

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone git@github.com:lucasbarzan/gorestaurant.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd gorestaurant

# Vá para a pasta do frontend
$ cd web

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

📱 Rodando a aplicação mobile (Frontend)

Siga as instruções deste link para configurar o ambiente de desenvolvimento mobile em React Native e poder rodar a aplicação na sua máquina.

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• EditorConfig
• ESLint
• Prettier
• json-server

Website (React + TypeScript)

• React Router Dom
• React Icons
• React Modal
• Unform
• Styled Components
• Axios
• Yup

Veja o arquivo package.json

Mobile (React Native + TypeScript)

• React Native Gesture Handler
• React Native Screens
• React Native Vector Icons
• React Native Safe Area Context
• Styled Components
• Axios

Veja o arquivo package.json

Utilitários

• Protótipo: Figma
• Editor: Visual Studio Code
• Teste de API: Insomnia
• Fontes: Poppins

---

💪 Como contribuir no projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---

🦸 Autor

_{Lucas Barzan}

---

📝 Licença

Este projeto esta sob a licença MIT.

Feito com ❤️ por Lucas Barzan 👋🏽 Entre em contato!