Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viniciusmoreria/foodfy
front-end challenge from launchbase bootcamp by rocketseat
https://github.com/viniciusmoreria/foodfy
bootcamp challenge faker fakerjs foodfy html javascript launchbase lottie multer nodejs nunjucks portfolio-site postbird rocketseat scss
Last synced: 3 months ago
JSON representation
front-end challenge from launchbase bootcamp by rocketseat
- Host: GitHub
- URL: https://github.com/viniciusmoreria/foodfy
- Owner: viniciusmoreria
- License: mit
- Created: 2020-02-29T11:21:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-17T15:58:36.000Z (almost 5 years ago)
- Last Synced: 2024-09-27T07:44:07.779Z (4 months ago)
- Topics: bootcamp, challenge, faker, fakerjs, foodfy, html, javascript, launchbase, lottie, multer, nodejs, nunjucks, portfolio-site, postbird, rocketseat, scss
- Language: JavaScript
- Homepage: https://fooodfy.herokuapp.com/
- Size: 7.56 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LaunchBase Bootcamp 🚀
## Goal
The objective of this challenge is to help fixate the content presented throughout the bootcamp. Where we should create a recipe site from zero with several features, as shown below.
## Features
- [x] Dynamic pages and content powered by Nunjucks.
- [x] Database powered by Postgresql.
- [x] Being able to add new recipes, update and delete them.
- [x] Search recipes.
- [x] Pagination.
- [x] Upload images to database using Multer.
- [x] Image Gallery with Lightbox feature.
- [x] Complete login system, with administrators and regular users.
- [x] Routes are safe thanks to Validators.
- [x] Nodemailer to reset and recover passwords.
- [x] Users, Chefs and Recipes seeds available thanks to Faker.js.
- [x] Feedback animations powered by Lottie.
## Technologies
This project was developed with the following technologies:
- [Node.js](https://nodejs.org/en/)
- [PostgreSQL](https://www.postgresql.org/)
- [Nunjucks](https://mozilla.github.io/nunjucks/)
- [Faker.js](https://github.com/marak/Faker.js/)
- [Lottie](https://github.com/airbnb/lottie-web)
## Getting Started
You need the following tools installed in order to run this project:
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Node.js + NPM](https://nodejs.org/en/), [PostgreSQL](https://www.postgresql.org/download/), and [Postbird](https://www.electronjs.org/apps/postbird).
1. Fork this repository and clone it into the current directory
```bash
git clone https://github.com/viniciusmoreeira/foodfy.git
```
2. Install dependencies
```bash
npm install
```
3. Set up the database
```bash
psql -U -c "CREATE DATABASE foodfy"
psql -U -d foodfy -f foodfy.sql
```
You can manually import the foodfy.sql to Postbird, remember to create a new database with the name Foodfy.
```bash
Important!
You have to alter the db.js, located in src/config to match your PostgreSQL settings.
You also have to alter the mailer.js, located in src/lib to match your Mailtrap settings.
```
4. Populate it with Faker.js
```bash
node seed.js
```
```bash
Important!
Every Faker user password is "pass" and every single one of them have administrator status.
```
5. Fire up the server and watch files
```bash
npm start
```
## License
This project is under the MIT license. See the [LICENSE](LICENSE) for details.