Skip to content

MyDryDay/Few-Fries-Short

Repository files navigation

Few_Fries_Short

Description

A collaborative project to create a review site that allows users to browse restaurants, look at reviews associated with the restaurants, read comments about the reviews and, if the user signs up, add/edit/delete reviews, add restaurants, and add comments on reviews.

Contents

Section Description
Installation How To Install & Dependancies
Usage How To Use The Application
Contributing Information For Those That Wish To Contribute
Testing Information Regarding Tests I've Carried Out
Questions Contact Information For Those That Have Questions
Contributors GitHub accounts of those who helped develop the site

Installation

The site can be accessed via the following link: https://few-fries-short.herokuapp.com/.
Alterantively, follow these instructions:

  1. Clone / Download this repository.
  2. Open the schema.sql file in mySQL workbench (located in the db folder).
  3. Run the query within.
  4. Navigate to the root of the repository with a CLI of your choice.
  5. Add a '.env' file and add credentials for 'DB_NAME', 'DB_USER' & 'DB_PASSWORD' (DB_NAME is ffs_db).
  6. Type 'npm install' and press the enter key.
  7. Type 'node server.js' and press the enter key.
  8. Open a browser of your choice and navigate to http://localhost:3001.

Usage

The following screenshots will demonstrate the usage of the site: Screenshot #1 Screenshot #2 Screenshot #3 Screenshot #4 Screenshot #5

Project created using the MIT license. Learn more...

Contributing

If you would like to contribute, please do so.

Testing

All testing was done both locally and on the deployed Heroku version. This testing was shared between the four authors and all features were tested.

Questions

GitHub: https://github.com/MyDryDay
LinkedIn: https://www.linkedin.com/in/george-cope-633b761bb
Telegram: https://t.me/G_Cope97

Contributors

Alisha Saleh - https://github.com/AlishaSaleh
Olivia Owen - https://github.com/oliviaowen1
Sally Rodgers - https://github.com/sallyxp

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •