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.
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 |
The site can be accessed via the following link: https://few-fries-short.herokuapp.com/.
Alterantively, follow these instructions:
- Clone / Download this repository.
- Open the schema.sql file in mySQL workbench (located in the db folder).
- Run the query within.
- Navigate to the root of the repository with a CLI of your choice.
- Add a '.env' file and add credentials for 'DB_NAME', 'DB_USER' & 'DB_PASSWORD' (DB_NAME is ffs_db).
- Type 'npm install' and press the enter key.
- Type 'node server.js' and press the enter key.
- Open a browser of your choice and navigate to http://localhost:3001.
The following screenshots will demonstrate the usage of the site:
License (https://opensource.org/licenses/MIT)
Project created using the MIT license. Learn more...
If you would like to contribute, please do so.
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.
GitHub: https://github.com/MyDryDay
LinkedIn: https://www.linkedin.com/in/george-cope-633b761bb
Telegram: https://t.me/G_Cope97
Alisha Saleh - https://github.com/AlishaSaleh
Olivia Owen - https://github.com/oliviaowen1
Sally Rodgers - https://github.com/sallyxp