computer-science-club

commit fcfabc51f5c6e15d2820fc83e6f48f701e06bdab
parent 4123f8ef2447ba26a2b844b51f29c55da1d8b908
Author: Damian Myrda <damian@prime8.dev>
Date:   Wed, 24 Apr 2024 14:47:59 -0500

Update README

Diffstat:
M
README.md
 | 
9
++++++++-
A
run.sh
 | 
2
++

2 files changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
 # computer_science_club
-A website for Computer Science Club.
+A website for Computer Science Club. It was made during a mini-hackathon.
+
+## setup
+To setup the server environment, run ```python -m venv .``` in the root of the project. Then, execute ```. ./bin/activate``` and you should be in the virtual environment. Lastly, run ```pip install flask schoolopy``` to install all the dependencies. Now, exit using by running ```exit```.
+
+## running
+To run the server, execute ```run.sh```.
+
diff --git a/run.sh b/run.sh
@@ -0,0 +1,2 @@
+. ./bin/activate
+flask --app main.py run