From e20eec2764d599b8d3426187c5205d9cb24bc29b Mon Sep 17 00:00:00 2001
From: Jagraj Aulakh <aulakhjagraj@gmail.com>
Date: Fri, 14 Apr 2023 21:02:40 -0400
Subject: [PATCH] Add README

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53aa073
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+This project uses React on the frontend and Flask on the backend. The goal of this
+project was to make a Brightspace clone/remake.
+
+# Running the code
+
+## Docker
+
+If you have docker and docker-compose installed, you can simply use the provided
+`docker-compose.yml` file.
+
+```sh
+echo "REACT_APP_BACKEND_URL=http://localhost:5000" > frontend/.env
+docker-compose up -d --build
+```
+
+Once both services are up, head to [http://localhost:8080](http://localhost:8080)
+
+**NOTE**: You might have to refresh the webpage a few times. For some reason it bugs out
+sometimes
+
+## Manual
+
+### Backend setup
+
+Run this in a new terminal
+
+```sh
+cd backend
+python -m venv venv
+pip install -r requirements.txt
+flask run
+```
+
+
+### Frontend setup
+
+Run this in a new terminal
+
+```sh
+cd frontend
+npm install
+npm start
+```
+