Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/i-ramoss/foodfy
Site de receitas desenvolvido em um dos principais desafios do bootcamp LaunchBase
https://github.com/i-ramoss/foodfy
css express foodfy html javascript launchbase mvc nodejs nunjucks postgres rocketseat
Last synced: 2 months ago
JSON representation
Site de receitas desenvolvido em um dos principais desafios do bootcamp LaunchBase
- Host: GitHub
- URL: https://github.com/i-ramoss/foodfy
- Owner: i-ramoss
- License: mit
- Created: 2020-06-24T15:01:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T05:53:39.000Z (about 2 years ago)
- Last Synced: 2024-09-26T07:43:51.242Z (3 months ago)
- Topics: css, express, foodfy, html, javascript, launchbase, mvc, nodejs, nunjucks, postgres, rocketseat
- Language: JavaScript
- Homepage:
- Size: 69.8 MB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:heavy_check_mark: Foodfy
Foodfy |
Tecnologias usadas |
Como usar |
Como contribuir |
Licença
## :interrobang: O que é o Foodfy?
O Foodfy é o desafio fullstack final do Bootcamp Launchbase, da Rocketseat.
É uma aplicação desenvolvida para o gerenciamento de receitas onde se é possível cadastrar os Chefs e suas respectivas receitas.
## :rocket: Tecnologias:
Este projeto foi desenvolvido com as seguintes tecnologias:
### Frontend:
- [HTML][html]
- [CSS][css]
- [JavaScript][js]
- [Nunjucks][njk]
- [SweetAlert2][swal2]
- [Lottie][lottie]
### Backend:
- [Node.js][nodejs]
- [Express][express]
- [PostgreSQL][postgresql]
- [PG][pg]
- [Multer][multer]
- [Nodemailer][nodemailer]
- [BcryptJs][bcryptjs]
- [Faker][faker]
## :fork_and_knife: Gif - Sessão Pública do Foodfy:
## :fork_and_knife: Gif - Sessão Administrativa do Foodfy:
## :construction_worker: Como usar: (Em desenvolvimento)
Para clonar e executar essa aplicação você vai precisar dos seguintes softwares instalados em seu computador:
- [Git][git]
- [Node][nodejs]
- [PostgreSQL][postgresql]
### :electric_plug: Instalar dependências
```bash
# Clone este repositório:
$ git clone https://github.com/i-ramoss/Foodfy.git
# Entre no repositório:
$ cd Foodfy
# Instale as dependências:
$ npm install
```
### Após instalar as dependências, deve-se configurar o banco de dados
Além do [PostgreSQL], instale o [Postbird][postbird] para gerenciamento e visualização do BD numa interface gráfica.
Após essas instalações, ligue o PostgreSQL.
*Perceba que a versão que estou usando neste projeto, é a versão 13. Caso a sua versão instalada seja outra, atente-se ao número da versão na pasta acima. Troque o 13 pela versão do seu postgres.*
#### Windows:
1. Abra o Powershell como administrador, e navegue até a pasta de instalação:
```bash
$ cd "C:\Program Files\PostgreSQL\13\bin\"
```
2. Inicie o postgres com o comando abaixo:
```bash
$ .\pg_ctl.exe -D "C:\Program Files\PostgreSQL\13\data" start
```
3. Após o uso, o comando para desligá-lo é:
```bash
$ .\pg_ctl.exe -D "C:\Program Files\PostgreSQL\13\data" stop
```
#### Mac:
1. Iniciar o postgres
```shell
pg_ctl -D /usr/local/var/postgres start
```
2. Desligar o postgresql
```shell
pg_ctl -D /usr/local/var/postgres stop
```
#### Linux:
[Documentação Oficial de Instalação do Postgres][postgres-linux]
### Utilizando o Postbird
Após ligar o Postgres, abra o Postbird e crie um banco de dados, de nome foodfy. *As informações de usuário e senha do postgres estão no arquivo src/config/db.js*.
Quando conectado, crie um banco de dados com o nome de foodfy. Após isso, importe um arquivo .sql e utilize o que está na raiz deste repositório.
Se não for possível realizar a importação, abra o arquivo sql e *copie toda a query* para a sessão de Query do Postbird e clique em Run Query
Caso as tabelas tenham sido criadas, a importação ocorreu com sucesso.
### Executar a aplicação
```bash
# Entre no repositório:
$ cd Foodfy
# Inicie a aplicação:
$ npm start
# A aplicação estará rodando na porta 5000 (http://localhost:5000/)
# Popule o DB com dados falsos, utilizando o Faker.js
$ node seeds.js
```
## :confetti_ball: Como contribuir:
- Realize um fork;
- Crie uma branch com sua funcionalidade: `git checkout -b my-feature`;
- Envie as mudanças realizadas: `git commit -m 'feat: My new feature'`;
- Faça um push da sua branch: `git push origin my-feature`.
Depois que a sua solicitação for aceita e adicionada ao projeto, você pode excluir a sua branch.
## :key: Licença:
Este projeto está sob licença MIT, para mais detalhes verifique em [LICENSE][license].
Feito com :green_heart: por **Ian Ramos** :fire: [Entre em contato!][linkedin]
[html]: https://developer.mozilla.org/pt-BR/docs/Web/HTML
[css]: https://developer.mozilla.org/pt-BR/docs/Web/CSS
[js]: https://developer.mozilla.org/pt-BR/docs/Web/JavaScript
[nodejs]: https://nodejs.org/en/
[express]: https://expressjs.com/pt-br/
[njk]: https://mozilla.github.io/nunjucks/
[postgresql]: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
[postgres-linux]: https://www.postgresql.org/download/linux/
[pg]: https://github.com/brianc/node-postgres/tree/master/packages/pg
[postbird]: https://www.electronjs.org/apps/postbird
[multer]: https://github.com/expressjs/multer
[swal2]: https://sweetalert2.github.io/
[lottie]: https://github.com/airbnb/lottie-web
[nodemailer]: https://nodemailer.com/about/
[bcryptjs]: https://www.npmjs.com/package/bcrypt
[faker]: https://github.com/marak/Faker.js/
[git]: https://git-scm.com
[license]: https://github.com/i-ramoss/Foodfy/blob/master/LICENSE
[linkedin]: https://www.linkedin.com/in/ian-ramos/