Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martins-rafael/foodfy
:fork_and_knife: Web app de gerenciamento de receitas e chefs.
https://github.com/martins-rafael/foodfy
express foodfy javascript launchbase nodejs nunjucks postgresql rocketseat
Last synced: about 1 month ago
JSON representation
:fork_and_knife: Web app de gerenciamento de receitas e chefs.
- Host: GitHub
- URL: https://github.com/martins-rafael/foodfy
- Owner: martins-rafael
- License: mit
- Created: 2020-05-29T23:30:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T22:36:31.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T18:22:33.139Z (about 2 months ago)
- Topics: express, foodfy, javascript, launchbase, nodejs, nunjucks, postgresql, rocketseat
- Language: JavaScript
- Homepage:
- Size: 13.6 MB
- Stars: 29
- Watchers: 1
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Foodfy
Aprenda a construir os melhores pratos com receitas criadas por profissionais do mundo inteiro.
## Tópicos
[Sobre o Foodfy](#sobre-o-foodfy)
[Funcionalidades](#funcionalidades)
[Tecnologias e Ferramentas](#tecnologias-e-ferramentas)
[Instalação e uso](#instalação-e-uso)
[Licença](#licença)
## Sobre o Foodfy
O Foodfy é uma aplicação web completa de gerenciamento de receitas, desenvolvida durante o bootcamp LaunchBase da [Rocketseat](https://rocketseat.com.br/), usada como critério de avaliação dos conhecimentos obtidos durante o treinamento.
Main
Admin
Email de boas-vindas
## Funcionalidades
- [X] Explore variados tipos de receitas.
- [X] Gerencie receitas, chefs e usuários.
- [X] Upload de imagems com Multer.
- [X] Pesquisar receitas.
- [X] Páginas dinâmicas com Nunjucks.
- [X] Banco de dados PostgreSQL.
- [X] Sistema de login e recuperação de senha.
- [X] Área administrativa.
## Tecnologias e Ferramentas
As seguintes tecnologias foram utilizadas no desenvolvimento do projeto:
- [HTML](https://devdocs.io/html/)
- [CSS](https://devdocs.io/css/)
- [JavaScript](https://devdocs.io/javascript/)
- [Nunjucks](https://mozilla.github.io/nunjucks/)
- [NodeJS](https://nodejs.org/en/)
- [Nodemailer](https://nodemailer.com/about/)
- [Express](https://expressjs.com/)
- [Express Session](https://github.com/expressjs/session)
- [Multer](https://github.com/expressjs/multer)
- [PostgreSQL](https://www.postgresql.org/)
- [BcryptJS](https://github.com/dcodeIO/bcrypt.js)
- [Faker.js](https://github.com/Marak/Faker.js)
## Instalação e Uso
Para rodar a aplicação, você precisa instalar o [Node](https://nodejs.org/en/) e o banco de dados [Postgres](https://www.postgresql.org/).
Siga os passos abaixo:
```bash
# Abra um terminal e copie este repositório com o comando
$ git clone https://github.com/martins-rafael/foodfy.git
# ou use a opção de download.
# Entre na pasta com
$ cd foodfy
# Instale as dependências
$ npm install
# Crie o banco de dados e as tabelas utilizando os comandos
# inclusos no arquivo "foodfy.sql".
# Conexão com o banco de dados:
# Abra e edite o arquivo "db.js" dentro da pasta "src/config"
# com o seu user e password do Postgres.
# Popule o banco de dados usando o aquivo "seed.js":
$ node seed.js
# Rode a aplicação
$ npm start
```
**Importante:** Não exclua ou altere as imagens de placeholder diretamente da pasta `plublic/images`, pois as receitas e chefs gerados pelo `seed.js` compartilham desses arquivos entre si. Porém, é seguro deletá-las pela área administrativa do site.
### Acessando a Área Administrativa
Selecione um email da tabela users, acesse a tela de login e entre utilizando o mesmo com a senha "rocket" (senha padrão).
Dica: usuários administradores possuem a badge "ADMIN" no header:
### Criando Novos Usuários e Recupeção de Senha
Para usar estes recursos, edite o arquivo `mailer.js` dentro da pasta `scr/lib` com suas credenciais.
## Licença
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](/LICENSE) para mais detalhes.
---
Feito com :purple_heart: by [Rafael Martins](https://github.com/martins-rafael)
[](https://www.linkedin.com/in/rafaeldcmartins/)
[](mailto:[email protected])