🚧 README customizado em construção ! 🚧

Índice

1. Sobre o Projeto
   • O aplicativo contém
   • Construido Com
2. Começando
   • Instalação
   • Configurando
   • Executando
3. Uso
4. Contato
5. Agradecimentos

Sobre o Projeto

Nesse projeto, Meu grupo foi responsável por criar e integrar tanto o back-end quanto o front-end, criando uma plataforma de delivery de bebidas. 🍹

O projeto não foi só codar, mas também é trabalhar em equipe, aprender e se divertir muito!

O aplicativo contém:

Acesso via login:
Tanto clientes como pessoas vendedoras, assim como admin, que administra o sistema, tem acesso ao aplicativo via login, porém para funções diferentes:

• A pessoa cliente, que compra da lista de produtos;
• A pessoa vendedora, que aprova, prepara e entrega;
• A pessoa administradora, que gerencia quem usa o aplicativo;

Faz a comunicação entre clientes e pessoas vendedoras:
A pessoa cliente faz o pedido via "carrinho de compras" e a pessoa vendedora aprova, prepara e envia esse pedido. Quando o produto é recebido por quem o comprou, essa pessoa marca o pedido como "recebido". Ambos possuem detalhes sobre seus pedidos;

Se a pessoa cliente faz o pedido, o mesmo deve aparecer para a pessoa vendedora em seu dash de pedidos após a atualização da página. A pessoa cliente, pode ver as informações sobre seu pedido quando sua página for atualizada, ou seja, ter informações se o pedido está sendo preparado ou se já saiu pra entrega;

(voltar ao topo)

Construido Com

Front-end

• 
• 
• 
• 
• 
• 
• 

Back-end

• 
• 
• 
• 
• 
• 
• 
• 
• 

(voltar ao topo)

Começando

Instalação

1. Clonar o repositorio

    git clone [email protected]:RenanFernandess/trybe-project-delivery-app.git
   

2. Entrar na pasta project-delivery-app

    cd ./trybe-project-delivery-app
   

3. Instalar pacotes NPM

    npm install
   

Configurando

1. Entrar na pasta do back-end

    cd back-end
   

Docker

O Docker está sendo utilizado para criar um container para o banco de dados MySQL.

1. Iniciar o Docker Compose

    docker-compose up -d
   

Ambiente

Para que a API funcione é necessário configurar as variáveis de ambiente.

1. Criar arquivo .env

    touch .env
   

2. Configurar as variáveis

    NODE_ENV=development
    API_PORT=3001
    MYSQL_HOST=localhost
    MYSQL_PORT=3306
    MYSQL_USER=root
    MYSQL_PASSWORD=password
    MYSQL_DB_NAME=delivery-app
    EVAL_ALWAYS_RESTORE_DEV_DB=true
   

   Você pode seguir como exemplo o arquivo .env.example na pasta back-end.

Executando

1. voltar para pasta raiz do projeto

    cd ..
   

   pasta trybe-project-delivery-app

2. iniciar o aplicativo

    npm start
   

   após o start por padrão você será redirecionado para uma página do seu navegador com a seguinte URL:

    http://127.0.0.1:3000/
   

(voltar ao topo)

Uso

Front-end

Customer

Seller

Admin

Back-end

Scripts

(voltar ao topo)

Contato

• Fabiana Moraes - Linkedin - GitHub
• Gabriel Raeder - Linkedin - GitHub
• Renan Fernandes - Linkedin - GitHub - [email protected]
• Rubens Deola - Linkedin - GitHub

(voltar ao topo)

Agradecimentos

• Trybe
• Best-README-Template

(voltar ao topo)