🚧 Finished: Final challenge LauchBase Bootcamp 🚀 🚧

About • Features • Layout • How it works • Tech Stack • Contributors • Author • License • Versão em Português

💻 About

Foodfy - is a system for managing recipes, a way to connect chefs, recipes and lovers of a good meal made in an artenasal way, with their own hands-on experience.

Project developed during Bootcamp LaunchBase by Rocketseat. LaunchBase is an online bootcamp training that lasts 8 weeks with lots of practical content, challenges and hacks to take web development to the next level.

---

⚙️ Features

• The administrator has full access to the platform, where he can:

  • create, view, edit or delete chefs, users and recipes
  • register new administrators
  • when registering chefs and users, add:
    • Name or email of the chef or user
    • Avatar
    • Send encrypted password via registered email

• Registered users have exclusive access to the application, where they can:

  • browse the site to view the recipes and registered chefs
  • register recipes and assign them to their respective chefs
  • register a new password, in case you have forgotten
  • when registering a new recipe, the user can
    • Add up to 5 images of the recipe in png, jpg, or jpeg format
    • Choosing a chef
    • Title of the recipe
    • Full description of the ingredients
    • Complete step-by-step description of the method of preparation
    • Description of additional revenue information

• Any culinary user can:

  • browse the site to view the registered recipes
  • view the details of the recipes and their respective chefs
  • hide or show details, such as ingredients, preparation method and additional information

---

🎨 Layout

Web

---

🚀 How it works

Prerequisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, PostgreSQL, Postbird. In addition, it is good to have an editor to work with the code like VSCode.

🧭 Running the application

# Clone this repository
$ git clone /~https://github.com/wellingtoncid/foodfy.git

# Access the project folder cmd/terminal
$ cd foodfy

# install the dependencies
$ npm install

#Set up the database
psql -U <username> -c "CREATE DATABASE foodfydb"
psql -U <username> -d foodfy -f foodfydb.sql

You can manually import the foodfy.sql to Postbird, remember to create a new database with the name foodfydb.
- 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.

# Populate it with Faker.js
node seed.js

-Attention:
The Faker user password is "1234", you need to check each users settings on Postbird.

# Run the application in development mode
$ npm run start

# The application will open on the port: 3000 - go to http://localhost:3000

---

🛠 Tech Stack

The following tools were used in the construction of the project:

Website/Server (Javascript) (NodeJS)

• Express
• PostgreSQL
• Multer
• NodeMailer
• Faker

See file package.json

Utilities

• Editor: Visual Studio Code
• Animation: Lottie
• Fonts: Roboto, Material icons

---

👨‍💻 Contributors

Wellington Cid 👨‍🚀

💪 How to contribute

1. Fork the project.
2. Create a new branch with your changes: git checkout -b my-feature
3. Save your changes and create a commit message telling you what you did: git commit -m "feature: My new feature"
4. Submit your changes: git push origin my-feature

If you have any questions check this guid on how to contribute in GitHub

---

🦸 Author

_{Wellington Cid} 🚀

---

📝 License

This project is under the license MIT.

Made with ❤️ by Wellington Cid 👋🏽 Get in touch!

---

Versão em Português

Português 🇧🇷