Skip to content

Latest commit

 

History

History
148 lines (114 loc) · 4.85 KB

LEIAME.md

File metadata and controls

148 lines (114 loc) · 4.85 KB
Raw

foodfy


README.md

Indice


🧾 Sobre

Aplicação WEB para apresentação de receitas elaboradas por diversos chefs.
(Este é um projeto criado durante o Bootcamp Launchbase da Rocketseat).

🚀 Tecnologias utilizadas

Este projeto foi desenvolvido utilizando as seguintes tecnologias:

  1. Back-end
  2. Front-end

🔽 Como baixar o projeto

$ git clone https://github.com/victorbadaro/foodfy.git

💻 Como executar o projeto

Siga os passos abaixo:

  1. Entre no diretório do projeto

    $ cd foodfy

  2. Instale as dependencias do projeto

    $ npm install

  3. Abra o arquivo database.sql e execute todos os comandos que estão nele dentro do teu banco de dados (Steps: 1, 2, 3 e 4)

    Você deve ter o banco de dados PostgreSQL instalado na tua máquina

  4. Preencha as variáveis de ambiente contidas no arquivo .env na raíz do projeto Para ter usuário e senha da aplicação Mailtrap (utilizada para testar o envio de emails da aplicação Foodfy) você precisa criar uma conta em https://mailtrap.io/ e dentro de um dos teus inboxes selecionar a integração com o Nodemailer como na imagem abaixo: 

    # SERVER (optional)
PORT=

# DATABASE
DB_USER=
DB_PASSWORD=
DB_HOST=
DB_PORT=
DB_DATABASE=foodfy

# MAILTRAP
MAILTRAP_USER=
MAILTRAP_PASSWORD=

  5. No terminal execute o seguinte comando para popular o banco de dados:

    $ node seed

    Se tudo executar corretamente a seguinte mensagem será apresentada no terminal:

    Database is ready to be used now
Run one of the following commands on your terminal (without quotes):
"npm run dev" (if you want to run the app on developer mode)
"npm start" (if you want to run the app on production mode)

    Atenção: especificamente para executar o seed.js você deve, antes de executá-lo, colocar os dados de conexão do banco de dados diretamente no arquivo src/config/db.js, pois as variáveis de ambiente (.env) só funcionarão com o servidor executando. Após a execução do seed.js você poderá retornar o código original no arquivo src/config/db.js:

    const { Pool } = require('pg');

module.exports = new Pool({
    user: process.env.DB_USER,
    password: process.env.DB_PASSWORD,
    host: process.env.DB_HOST,
    port: process.env.DB_PORT,
    database: process.env.DB_DATABASE
});

  6. Execute um dos seguintes comandos no teu terminal

    Para somente executar o projeto

    $ npm start

# O endereço da tua aplicação estará disponível em http://localhost:3333

    Para executar o projeto no mode desenvolvedor. Executando assim, o servidor reiniciará automaticamente quando alguma alteração for realizada no código do projeto e também já irá atualizar as páginas da aplicação quando alguma alteração for feita em sua estrutura ou estilização

    $ npm run dev

# O endereço da tua aplicação estará disponível em http://localhost:3000

✅ Pronto! Se você seguiu corretamente os passos acima o projeto já estará sendo executado localmente em tua máquina.

Desenvolvido com ❤ por Victor Badaró