ABANDONED on February 13, 2024, please see newer version in the main branch.
This example contains a frontend and backend:
- The frontend is an Express application using an MVC architecture and Pug + Bootstrap4 for view templating.
- The backend is a GraphQL API providing the ability to create, delete, and list reservatios plus available rooms for a given date range.
For a solution that is more scalable than this, please checkout my React-FastAPI-TortoiseORM version of this same idea.
Booked reservations are listed via the API. Each reservation request were processed in the order provided as if they were real-time requests. The following rules are observed:
Context:
- When a room is reserved, it cannot be reserved by another guest on overlapping dates.
- Whenever there are multiple available rooms for a request, the room with the lower final price is assigned.
- Whenever a request is made for a single room, a double bed room may be assigned (if no single is available?).
- Smokers are not placed in non-smoking rooms.
- Non-smokers are not placed in allowed smoking rooms.
- Final price for reservations are determined by daily price * num of days requested, plus the cleaning fee.
Web UI Usage:
API Usage:
Example usage via curl:
# First, grab an access token provided by the API
ACCESS_TOKEN=$(curl -s -X POST \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=password&username=example-user&password=example-user' \
'http://localhost:8080/token' | jq -r '.access_token')
# List all existing booked reservations
curl http://localhost:$API_PORT/development/graphql \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{"query": "query { getAllReservations { reservations { room_id checkin_date checkout_date } } }"}'
# Create a new reservation
# Note: if there is an overlap, you'll see a
# 'Reservation dates overlap with an existing reservation' error message
# To see the aforementioned error, run this mutation a multiple times
curl http://localhost:$API_PORT/development/graphql \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{ "query": "mutation { createReservation( input: { room_id: \"91754a14-4885-4200-a052-e4042431ffb8\", checkin_date: \"2023-12-31\", checkout_date: \"2024-01-02\" }) { success errors reservation { id room_id checkin_date checkout_date total_charge } } }" }'
# List Available Rooms for a given date range
curl http://localhost:$API_PORT/development/graphql \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{"query": "query { getAvailableRooms( input: { checkin_date: \"2023-12-31\", checkout_date: \"2024-01-02\" }) { success errors rooms { id num_beds allow_smoking daily_rate cleaning_fee } } }" }'Open API UI Usage:
Navigate to http://localhost:$API_PORT/docs.
Table of Contents:
To run the service, you will need to install the following tools.
The below are optional but highly recommended:
First, we'll need to set up our environment variables. You can do this by either:
- Manually exporting the necessary environment variables in your shell. These are listed in the
./envrc.examplefile.
or
- Use optionally use Direnv.
cp .envrc.example .envrc
direnv allowFor exporting environment variables, Python Dotenv is an option as well. However, Direnv is preferred as it isn't dependent on Python therefore can be used in other use-cases.
Execute the following in your terminal:
python -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txtExecute the following within your terminal:
nvm use # To eliminate any issues, install/use the version listed in .nvmrc.
npm i # install the packages needed for project Finally, let's create and seed the databases and our Reservations and Rooms tables:
# Create the databases and seed them
NODE_ENV=development | ./create_db.sh && npm run refresh && npm run seed
NODE_ENV=test | ./create_db.sh && npm run refreshDuring development, you can just execute npm run dev:db-baseline to refresh the database back to the original seed data.
To run both the frontend and backend concurrently:
docker-compose up -d # runs the database in the background
npm run devAlso, you just execute the backend via npm run dev:backend. to verify the backend is working:
curl http://localhost:$API_PORT/$ENV/aboutYou can also acces the Ariadne GraphiQL (interactive test playground) instance at http://localhost:$API_PORT/$ENV/graphql.
The frontend utilizes Jest. To run these tests, simply execute npm run test:frontend.
The backend tests organized for improved readability and comprehension. These tests are segmented into individual files, a structure that simplifies the testing process and enhances accessibility. While individual preferences may vary, this is my chosen approach for managing tests in this project.
To run these tests, simply execute npm run test:backend.
- The UI's flow is not great, goal was to get a UI up and running for testing the backend. So, changes to implement are:
- Make caching middleware. Also, it's not as clean as I would like.
- When making a new reservation, validation should happen in place and not redirect to a modal.
- Enforce typing:
- JavaScript -> I'll eventually introduce JSDoc as an alternative to TypeScript.
- Python -> I need to sprinkle more type annotations. Also, I need to evaluate if usage of Union and Optional are more helpful that they look.
- Add GitHub Action for validating pull requests
- Add GitHub Actions for deployment to AWS
- Add Pulumi or Amazon CDK artifacts for managing AWS infrastructure supporting our code.
- Add Cypress for testing the UI
- Use Strawberry or Apollo instead of Ariadne
License information can be found here
