Better dx (Berkeley-CS61B#29)

Use Docker for local DB

.env.example

@@ -1,7 +1,7 @@
 # This is an example of what the .env should look like
 
-# Database
-DATABASE_URL='<DB_URL>'
+# Database - Replace for production
+DATABASE_URL='mysql://root:prisma@localhost:3306/sohq'
 
 NEXT_PUBLIC_HOSTNAME='http://localhost:3000'
 
@@ -13,4 +13,4 @@ NEXTAUTH_URL='http://localhost:3000'
 
 # Ably
 ABLY_SERVER_API_KEY='<ABLY_SERVER_API_KEY>'
-NEXT_PUBLIC_ABLY_CLIENT_API_KEY='<ABLY_CLIENT_API_KEY>'
+NEXT_PUBLIC_ABLY_CLIENT_API_KEY='<ABLY_CLIENT_API_KEY>'

README.md

@@ -51,7 +51,22 @@ Google OAuth is used for authentication.
 <details>
 <summary>Database</summary>
 
-SOHQ uses MySQL as its database, mainly because the free tier of <a href="https://planetscale.com">Planetscale</a> is very nice. For local development, I am currently looking into possibly using Docker to have a local MySQL instance.
+#### Local Development 
+For local development we run a docker container serving a mySQL database.
+
+1. Install [Docker](https://docs.docker.com/get-docker/) on your machine.
+
+2. Start the container by running:
+```
+docker compose up
+```
+
+
+#### Production
+
+
+
+For the production environment, the free tier of <a href="https://planetscale.com">Planetscale</a> is very nice.
 
 1. Create a new database on <a target="_blank" href="https://planetscale.com">Planetscale</a>.
 

docker-compose.yaml

@@ -0,0 +1,18 @@
+version: '3'
+services:
+  mysql-db:
+    image: mysql:5.7
+    restart: always
+    ports:
+      - '3306:3306'
+    ulimits:
+      nofile:
+        soft: 65536
+        hard: 65536
+    environment:
+      MYSQL_ROOT_PASSWORD: prisma
+    volumes:
+      - mysql:/var/lib/mysql
+volumes:
+  mysql: ~
+