FOODFY

Project developed at the Rocketseat - BOOTCAMP LAUNCHBASE.

Table of Contents

1. About The Project
   • Built With
   • Objective
   • Status
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

An application that stores Recipes from multiples Chefs and Users, project created as a conclusion work to graduate on LAUNCHBASE ROCKETSEAT Bootcamp Its a great project where i learned authentication, encrypt passwords, back-end and front-end validation, MVC architeture, upload files, user session, sending emails, login and password recovery, SQL queries and a lot of other cool stuff.

(back to top)

Built With

• HTML
• CSS
• Javascript
• Node.js
• Nunjucks (template engine)
• Express.js (server)
• Express-session
• PostgreSQL (database)
• NodeMailer (emails)
• Multer (upload files)
• Faker (fake data)
• BcryptJS (hash passwords)
• Method-override (HTTP verbs PUT/DELETE)
• Connect-Flash (User alerts)
• AWS S3

(back to top)

Objective

Project developed for educacional purposes.

(back to top)

Status

Finished.

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• PostgreSQL

Installation

1. Clone the repo

   git clone https://github.com/MarioDoncel/LaunchBase

2. Install NPM packages

   npm install

3. Run on PostgreSQL the queries that are in database.sql to create a database "foodfy" and all the tables that are necessary.

4. Configure your access to database on src/config/db.js

   module.exports = new Pool({
      user: "postgres",
      password: "xxxxxx",
      host:"localhost",
      port: "5432",
      database: "foodfy"
    });

5. If you want to populate your database with fake data to test the application you can run the command

   node seed.js

6. Run the application

   npm start

(back to top)

Usage

Public Session

• HomePage - Homepage with six highlighted recipes

• Public About/Recipes/Chefs/SearchResults Pages - Here you have the pages to the public user. This user can navigate through the recipes, see all the chefs that exists on this platform and read the about section

Logged Users and Admin Session

• Admin LogIn/PasswordRecovery/Recipes/Chefs/Users Pages - Here the logged users can manage their recipes and chefs registereds, also exists an Admin user who has access to everything from anyone and make the registered users management

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mario Andres Doncel Neto

Email - 88mario.doncel@gmail.com
Whatsapp - +55 19 99612 9909

Project Link: https://github.com/MarioDoncel/LaunchBase

(back to top)

Acknowledgments

• Rocketseat

(back to top)