pantry-hacker

Purpose

A simple search tool for quick recipe information.

Table of Contents

• Preview
• Installation
• Tests
• Documentation
• Feedback

---

Preview

Here is how the application appears and functions.

Installation

This project requires Node.js and other dependencies

• How to install Node

Navigate to the directory you would like to use using the CLI and then clone this repository:

git clone git@github.com:wolfgarb/pantry-hacker.git

Create .gitignore to include the following:

node_modules
.env
.DS_Store
package-lock.json

.env will hold your sensitive information.

DB_NAME='pantry_hacker_db'
DB_USER='root'
DB_PW='YOUR_PASSWORD_HERE'

Open your IDE and use these commands to install all the necessary packages:

npm i bcrypt mysql2 dotenv express sequelize node
connect-session-sequelize express-handlebars express-session handlebars
npm init

npm init will create your package.json file. Make sure package.json includes the seed in your scripts:

"scripts": {
    "start": "node server.js",
    "seed": "node seeds/index.js"
}

Login to MySQL with your credentials.

mysql -u root -p

In the MySQL terminal, start the database

USE pantry_hacker_db;

Go back to your main terminal or VS Code powershell and enter

npm run seeds

Finally, start the server from the command line:

npm start

Tests

This project used Jest for testing

Documentation

• npm
• MySQL2
• Express
• Sequelize
• Handlebars

Feedback

Have something you'd like to add?
Feel free to contact me via email!