https://github.com/earthskyorg/overlook
OverLook
https://github.com/earthskyorg/overlook
Last synced: 3 months ago
JSON representation
OverLook
- Host: GitHub
- URL: https://github.com/earthskyorg/overlook
- Owner: earthskyorg
- Created: 2022-10-28T21:14:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-28T21:18:15.000Z (over 2 years ago)
- Last Synced: 2025-01-19T23:31:22.977Z (5 months ago)
- Language: JavaScript
- Size: 984 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overlook
An application commissioned by the Overlook Hotel. The app is tailored around the hotel's esteemed guests; delivering the bookings schedule of all of the hotel's most finest quarters. Never doubt that you'll find the room that you deserve, because at the Overlook, you are taken care of.
## Features
### The Guest
- Guest may book a hotel room
- Guest may view any prior or future bookings
- Guest may narrow down their search by date if the many rooms become exhausting
- If guest feels awful looking at single rooms or junior suites, then they may view just the residental suite instead
- Dare I say, if there is ever a mistake in availabilty then will be do our _**best**_ in our duty to make things right.
### The Manager
- The managers will also get their own version of the application
- They may see what all of the many rooms are available for the current date
- They can see the influx of wealth of the current day
- No math ever required to find out the percentage of available rooms for the current date
- They can search any guest they desire, amongst their bookings and spendings
- They can reserve a room for any guest
- But as any good manager ought to, they can axe the guest bookings if they deserve it
## Tech Stack
**Languages:** HTML5, CSS, Sass, JavaScript
**Server:** the Fetch API
**Testing:** Mocha & Chai
## Demo
## Installation
Clone the revere repo and appreciate its journey to making you feel _venerated._
```zsh
git clone [email protected]:andrewvallejo/overlook.git
```
The next part, my favorite part, `cd` into the directory and run
```zsh
npm install
```
Marvelous. `CD` out of there once able to break your gaze away. Then clone this
```zsh
git clone [email protected]:turingschool-examples/overlook-api.git
```
Once again, `CD` on in and when you feel delighted to, install the dependencies
```zsh
npm install
```
See how easy we made that for you? This is a hotel you can trust with earnest.
## Deployment
To view the project for all its majesty, `CD` into the Overlooks directory and run
```zsh
npm start
```
On a different terminal, `CD` into the Overlook API directory and run
```zsh
npm start
```
Are you ready? Click on the link to see your new home for night, you deserve it
```zsh
http://localhost:8080/
```
## Running Tests
Still not satsified? Don't worry, we believe in transpency. We have all our basis covered, our next objective is gaining your trust.
Feel free to a test within our directory to see we didn't cut any corners here at the Overlook.
```zsh
npm run test
```
## Lighthouse Report
## Created by Andrew Vallejo
- My [Github](https://www.github.com/andrewvallejo)
- My [Linkdin](https://www.linkedin.com/in/andrewvallejo/)