Food Forward

Table of contents

• Description of the project
• Technologies used
• Usage
• Installation
• Credits
• Link URL to GitHub Repository
• Link URL of deployed app to Heroku

Description of the project

This project is a full-stack application using Model-View-Controller (MVC) paradigm and is deployed on Heroku. It is a food bank website directed towards its employees where they will be able to login safely into their account via email and protected password, have access to the food bank customer's personnal information, modify, and delete these database information. The employees also have access to a social media like platform where they can post information concerning their work at the food bank, comment on these posts and like.

Technologies used

Project is created using:

• JavaScript
• Nodejs
• Expressjs
• Path
• Express session
• Sequelize
• MYSQL
• MYSQL2
• Handlebarsjs
• Heroku
• dotenv

Usage

Installation

Here are some guidelines for installing the project on your local machine:

1. Clone or download the repository to your own local machine and run it from your command line.

2. Then, make sure that your repo includes a package.json with the required dependencies. You can create one by running npm init in your command line.

3. Run npm i or npm install in order to download all the dependencies.

4. Store your variables in an .env file. Some of the variables you will need are: DB_NAME, DB_PW and DB_USER for your local database credentials, DB_EMAIL and DB_PASS for nodemailer/contact-from credentials. And don't forget to include your .env file into your .gitignore to keep your credentials secret.. 🤫

5. Run node server.js or node server in your terminal to launch the application. Or check the deployed app directly on our heroku link (https://stark-reaches-12893.herokuapp.com/).

6. Enjoy and don't hesitate to contribute! 🙂

Credits

Wayne Edwards: https://github.com/WayneEdwards Noemie Grau: https://github.com/Noemiegrau Tricia Strickland: https://github.com/tstrickland88

Link URL to GitHub Repository

https://github.com/Noemiegrau/food-forward

Link URL of deployed app to Heroku

https://stark-reaches-12893.herokuapp.com/