Added docs

README.md

@@ -1,2 +1,29 @@
 # nova-web
 🌐 [Website](https://nova-oss.com) of project Nova.
+
+## Set up your `.env` file
+
+```bash
+CORE_API_URL="Used for accessing the database from nova-api. Usually, it's http://localhost:2333 (and :2332 for testing)."
+CORE_API_KEY="The CORE_API_KEY set in the .env of nova-api."
+CONTACT_EMAIL="The E-Mail address displayed on the website. Used for accessing databases."
+TOS_VERIFICATION_KEY="Generate a password without special symbols and put it in here. Used in nova-cord."
+DISCORD_CLIENT_ID="For 'auth using Discord' in the account dashboard. Get this from the Discord developer portal"
+DISCORD_CLIENT_SECRET="For 'auth using Discord' in the account dashboard. Get this from the Discord developer portal"
+FLASK_SECRET_KEY="Generate a password without special symbols and put it in here. It is used to encrypt the session cookie etc."
+```
+
+## Running
+### Production
+```bash
+sh screen.sh
+````
+or
+```bash
+python web
+```
+
+### Development
+```bash
+python web/app.py
+````

web/account.py

@@ -1,7 +1,6 @@
 import os
 import flask
 import requests
-import functools
 
 from dotenv import load_dotenv
 from requests_oauthlib import OAuth2Session

web/app.py

@@ -26,7 +26,7 @@ def create_app() -> flask.Flask:
     account.register(app)
     finances.register(app)
 
-    # max 100 MB
+    # max file size 100 MB (cloudflare limit)
     app.config['MAX_CONTENT_LENGTH'] = 100 * 1024 * 1024
 
     @app.context_processor

web/finances.py

@@ -13,20 +13,24 @@ load_dotenv()
 # cache get_finances() for 5 minutes
 
 def get_finances():
-    return requests.get(
+    res = requests.get(
         url=f'{os.environ["CORE_API_URL"]}/finances',
         headers={
             'Authorization': f'{os.environ["CORE_API_KEY"]}'
         },
         timeout=5
-    ).json()
+    )
+    res.raise_for_status()
+
+    return res.json()
 
 def register(app):
     @app.route('/finances')
     def finances_view():
         try:
             data = get_finances()
-        except Exception:
+        except Exception as exc:
+            print(exc)
             return flask.Response('Error fetching finances from database. This might be cause the data is still being processed. Please allow up to a few minutes.', status=500)
 
         donations = data['donations']

web/templates/index.html

@@ -7,7 +7,7 @@
     <a href="https://discord.nova-oss.com" target="_blank">
         <button class="special">
             <i class="bi bi-discord"></i>
-            Join 5,000+ members
+            Join 6,000+ members
         </button>
     </a>
     <!-- <a href="https://chat.nova-oss.com" target="_blank">