Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.82 KB

README.md

File metadata and controls

93 lines (63 loc) · 3.82 KB
Raw

Reserve a Room

TABLE OF CONTENTS

1. TABLE OF CONTENTS
2. LICENSE
3. PROJECT DESCRIPTION
4. APPLICATION LINKS
5. CONTRIBUTIONS
6. INSTALLATION
7. USAGE
8. TESTING
9. SCREENSHOT

LICENSE

MIT

This application is covered under the MIT License

PROJECT DESCRIPTION

This app creates a website that allows the user to reserve a room or a venue to host an event. The user’s will be able to see what the space may include like a basketball court, ping pong tables, table and chairs, or whatever the space includes. Then the user will be able to see a calendar showing the rooms or venues and what times are available to be reserved. If a time is booked and it is a public event it will show what event is going on at that time. If its not a public event it will show that it is booked for a private event. The site will require all users to sign up to be able to reserve a room. We are using Heroku to host the website and using JawsDB for the database.

APPLICATION LINKS

Website

GitHub Repository

CONTRIBUTIONS

Please contact us for all application inqueries.

Nate Bailey Justin Young Will Harrison John Robinson
[email protected] [email protected] [email protected] [email protected]
github github github github

INSTALLATION

  1. To Install on LocalHost: Clone GitHub repository to local workspace
  2. Open terminal in project base directory and run "npm install"
  3. Copy contents of db/db-init.sql to your local MySQL workbench and run to create db.
  4. Edit .env.EXAMPLE file to have your local environment values
  5. Rename .env.EXAMPLE to .env
  6. In terminal run "npm run seed" to create initial db entries
  7. In terminal run "npm run start" to launch application

USAGE

To use this project, do the following:

  1. Ensure Installation Steps have been completed.
  2. For localhost: Open Browser and browse to URL https://localhost:3001
  3. You may view posts, login, create post, comment on posts, delete posts.

TESTING

To test this project, do the following:

  1. To test on Heroku, Ensure Installation steps are complete
  2. Verify Working on localhost, by performing Usage Steps
  3. Push your local project to heroku, in terminal run commmand "heroku login"
  4. Login to your Heroku account in the browser window that pops up, then return to terminal.
  5. Run command "heroku create my_blog_site", to create a heroku app from project
  6. Verify connection between github and heroku by running command "git remote -v"
  7. Push code to heroku by running "git push heroku main"
  8. Login to your Heroku account in web browser and find the app just published.
  9. In the menu bar select "more->Run console"
  10. In the console that comes up run "npm run seed", to create initial entries in heroku db.
  11. Select "settings" under your app in heroku browser and scroll down to "Domain" area.
  12. This is where it lists the domain to your hosted app, click the link to open your app website.
  13. Test app until satisfied.

SCREENSHOT