]> prime8.dev >> repos - csc.git/commitdiff
Update README
authorDamian Myrda <monkey.damianek@gmail.com>
Wed, 24 Apr 2024 19:47:59 +0000 (14:47 -0500)
committerDamian Myrda <monkey.damianek@gmail.com>
Wed, 24 Apr 2024 19:47:59 +0000 (14:47 -0500)
README.md
run.sh [new file with mode: 0755]

index bf10c7234a24eac5c88093f87d4f9a84e9da41d5..956dfd27108eda69aaff5d5a5f5c31626953b901 100644 (file)
--- 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
new file mode 100755 (executable)
index 0000000..b8861ec
--- /dev/null
+++ b/run.sh
@@ -0,0 +1,2 @@
+. ./bin/activate
+flask --app main.py run