Skip to content

VarejaoDaCarne/foodfy

Repository files navigation

Logo Foodfy

🍽 As melhores receitas.

GitHub contagem de linguagens Tamanho do repositório GitHub último commit License Stargazers

Home Page

🚧 Foodfy 🍽 Concluído 🚀 🚧

SobreFuncionalidadesComo executarTecnologiasAutorLicença

💻 Sobre o projeto

📺 Foodfy - Aprenda a construir os melhores pratos com receitas criadas por profissionais do mundo inteiro.

Projeto desenvolvido durante o Bootcamp Launchbase oferecido pela Rocketseat.


⚙️ Funcionalidades

🚧 Em construção... 🚧


🚀 Como executar o projeto

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto ter um editor para trabalhar com o código como VSCode

🧭 Rodando a aplicação

  1. Clone este repositório

    git clone https://github.com/grioos/foodfy
  2. Acesse a pasta do projeto no seu vscode

    cd foodfy
  3. Instale as dependências

    npm i
  4. Configure o Banco de dados (PostgreSQL) executando os comandos presente no arquivo database.sql.

    CREATE TABLE "" (
        "id" SERIAL PRIMARY KEY,
        "name" TEXT,
        "number" int NOT NULL
    );
  5. Execute o arquivo seed.js para popular o banco de dados.

    node seed.js
  6. Execute a aplicação

    npm start

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

📌 Importante

  • Vá para a pasta src/config e configure o arquivo db.js colocando seu usuário e senha de conexão com o PostgreSQL.

  • A senha de todos os usúarios criados com a seed.js é 123

  • Se executar o arquivo seed.js, tome cuidado ao excluir chefes ou receitas pois as imagens disponíveis na pasta public/imagens vão ser excluidas. Então, reponha as imagens excluídas com novas. Você encontrará imagens na pasta public/assets, copie a que desejar para a pasta public/imagens e renomeie para o mesmo nome da imagem apagada.

  • Limpe o banco de dados antes de popular novamente com a seed.js, comandos para limpar no arquivo database.sql

  • Configure o mailtrap no arquivo mailer.js, colocando suas credenciais.


🛠 Tecnologias

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

Veja o arquivo package.json


💪 Como contribuir para o 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


Gabriel Rios 🚀

Linkedin Badge Gmail Badge


📝 Licença

Este projeto esta sobe a licença MIT.

Feito por Gabriel Rios 👋🏻 Entre em contato!