The goals of this assignment are to start to use a MySQL database to store application data and to start using Docker to power our application. There are a few parts to this assignment, as described below.
You are provided some starter code in this repository that implements a solution to assignment 1. The starter code's API server is implemented in server.js, and individual routes are modularized within the api/ directory. The starter code also includes openapi.yaml and openapi.json files in the public/ directory. You can use these to generate documentation for the server to see how its endpoints are set up. Feel free to use this code as your starting point for this assignment. You may also use your own solution to assignment 1 as your starting point if you like.
Your first task for this assignment is to write a Dockerfile that packages the API server in this repo (or your own server from assignment 1) into a Docker image along with all of the server's runtime dependencies. Containers launched from this image should automatically start the server listening on a specified port, and you should be able to successfully make requests to the containerized server from the outside world (e.g. from your host machine).
Next modify the API server to use a MySQL database to store the following resources:
- Businesses
- Reviews
- Photos
The MySQL database should completely replace the existing JSON/in-memory storage for these resources. In other words, all API endpoints associated with these resources should use the MySQL database.
You should use the official MySQL Docker image on Docker Hub to power your MySQL database. Your MySQL setup should meet the following requirements:
-
You should write a script (e.g. a
.sqlfile) to initialize your MySQL database the first time you launch your container. See the MySQL Docker Image Docs for a description of how this works. Your database initialization should at a minimum create your database and all of the tables you'll need. If you like, you can also put some initial data into your database. -
Your database data should be persisted in a Docker volume. Note that by default, MySQL stores data in the directory
/var/lib/mysql. To persist data, it should be sufficient to create a Docker volume and mount it at this location. -
Your API server should read the location (i.e. hostname, port, and database name) and credentials (i.e. username and password) of the MySQL server from environment variables.
Using this setup, you should be able to launch an API server container and a MySQL container on the same Docker network and specify the correct environment variables to have your API server use the MySQL database in the MySQL container.
Finally, write a Docker Compose specification in docker-compose.yml that defines your two-container (API server and MySQL) application. Your specification should define everything needed to run the application, e.g. a Docker network, a Docker volume, etc. Launch and run your application using Docker Compose.
We'll be using GitHub Classroom for this assignment, and you will submit your assignment via GitHub. Just make sure your completed files are committed and pushed by the assignment's deadline to the master branch of the GitHub repo that was created for you by GitHub Classroom. A good way to check whether your files are safely submitted is to look at the master branch your assignment repo on the github.com website (i.e. https://github.com/OSU-CS493-Sp18/assignment-2-YourGitHubUsername/). If your changes show up there, you can consider your files submitted.
This assignment is worth 100 total points, broken down as follows:
-
20 points: API server is containerized using Docker, as described above
-
60 points: API server is modified to use MySQL to store businesses, reviews, and photos, as described above
-
20 points: API application (API server and MySQL) is specified in
docker-compose.ymland can be run using Docker Compose, as described above