Skip to content

thallesrafaell/devburger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

DevBurger

DevBurger é uma aplicação web moderna para gerenciamento de pedidos de hambúrgueres, desenvolvida com React, Node.js, Prisma e PostgreSQL.

🚀 Tecnologias

Backend

  • Node.js
  • Express
  • Prisma (ORM)
  • PostgreSQL
  • JWT para autenticação
  • Stripe para pagamentos
  • Swagger para documentação da API

Frontend

  • React
  • Vite
  • Material-UI
  • Styled Components
  • React Hook Form
  • Yup para validação
  • React Router DOM
  • Axios

📋 Pré-requisitos

  • Node.js (versão LTS)
  • Docker e Docker Compose
  • Yarn ou npm

🔧 Instalação

  1. Clone o repositório:
git clone [URL_DO_REPOSITORIO]
cd devburger
  1. Instale as dependências do backend:
cd api
yarn install
  1. Instale as dependências do frontend:
cd ../interface
yarn install
  1. Configure as variáveis de ambiente:
    • Copie o arquivo .env.example para .env em ambas as pastas (api e interface)
    • Preencha as variáveis necessárias

🚀 Executando o projeto

Usando Docker Compose

  1. Na raiz do projeto, execute:
docker-compose up -d
  1. Acesse:

Executando localmente

  1. Inicie o backend:
cd api
yarn dev
  1. Em outro terminal, inicie o frontend:
cd interface
yarn dev

📦 Scripts disponíveis

Backend

  • yarn dev: Inicia o servidor em modo desenvolvimento
  • yarn db:generate: Gera o cliente Prisma
  • yarn db:push: Sincroniza o banco de dados com o schema
  • yarn db:studio: Abre o Prisma Studio

Frontend

  • yarn dev: Inicia o servidor de desenvolvimento
  • yarn build: Cria a build de produção
  • yarn preview: Visualiza a build de produção localmente

📝 Documentação da API

A documentação completa da API está disponível através do Swagger UI em: http://localhost:3001/api-docs

🤝 Contribuindo

  1. Faça um fork do projeto
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

👨‍💻 Autor

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published