Fat Birds Full Stack Website

Table of Contents

Description
Installation
Technologies
Screenshots
Test
Questions

Description

Founded in 2020, Fat Birds Wing Bar is an asian fusion chicken wing restaurant based in Midland, Texas. As aspiring junior engineers, we, Diana Contreras Daniel Kang, Felix Gilbert Cagatin, have decided to build a full stack website for our client in order to aid them in expanding their reach and growing their online presence.

Installation

Installing the Files

1. Assuming the user already has Node.jsand MySQL installed, simply clone the repository via the git clone command.
2. Once the respository has been cloned, we must then install the required dependencies. This can be done via the npm install command.
3. Once the dependencies have been install, we then create an .env file. Within this file, add the following environmental variables

DB_NAME=FB_MENU_DB
DB_USER=<mysql username>
DB_PW=<mysql password>

SECRET_SESSION_KEY=<secret session key>
OWNER_REGISTER_KEY=<owner register key>

Creating the Database

4. Once the .env file has been populated by our own information, we must then create the database. First, change directories to the \db\ directory.
5. After moving to the \db\ directiory, run the following command, replacing <mysql username> with your mysql username.
   

mysql -u <mysql username> -p

6. Once we are logged in to mySQL, we can then run the mySQL file via:

source schema.sql

7. Then, quit the mysql command interface via the quit command, and move back into the root directory.
8. Lastly, we must populate our newly created database with seed values. To do this, run the following command, which will then populate our database:

node seeds/index,js

Creating an Account

9. To create an account, we must enter the secret key into our .env file under OWNER_REGISTER_KEY.
10. Once we add the admin key onto our .env file, we can then go to the Login route to create an account with our secret key.
11. Click on the register button, to register a new account with your email and password, then enter the key in the form field specified Key.
12. If successful, we will be directed to the login page, where we can simply input our login information to access the admin side website.

Technologies

Our full stack website utilizes the following technologies:

• Expess Handlebars
• Bootstrap
• Fontawesome
• Passport
• Passport-local JS
• Jest
• Supertest
• Sequelize
• Nodemon
• BCrypy
• Dotenv
• Express
• Mysql2
• Heroku
• Anime.js

Screenshots

Website

Admin Side

Each Admin Operation has the following options to choose from:

For example, The Following image is an update operation for Sauces:

Test

• Make sure to have installed everything from Installation
• If you want to run all test then in the terminal type npm test
• If you want to just run the tests for checking the handlebars, in the terminal type npm test handlebar.test.js
• If you want to just run the tests for the routes and their functionality, in the terminal type npm test route.test.js
  

Questions?

Reach us at the following with your questions:

Felix Cagatin

Github: cagatin

Email: cagatingilbert@gmail.com

Diana Contreras

Github: dcontrer83

Email: dcontrer98@gmail.com

Daniel Kang

Github: DKhubgit

Email: danielkang13@gmail.com []
(https://opensource.org/licenses/MIT)