added in Getting Started section to readme

.gitignore

@@ -139,4 +139,5 @@ logs/
 creds
 src/tools/googleTokenGen.py
 abSENT/
-secrets.ini
+secrets.ini
+testing_config.ini

README.md

@@ -18,7 +18,6 @@ Every school day, abSENT retrives the new absence list and parses it. It then qu
 
 ## Why?
 Refreshing Schoology 20 times every morning is somewhat draining.
-
 ## Contributors
 - [Kevin Yang](https://github.com/bykevinyang)
 - [Roshan Karim](https://github.com/karimroshan)
@@ -27,3 +26,36 @@ Frontend design by [Leah Vashevko](https://github.com/theaquarium)
 
 ## Disclaimer:
 abSENT as a project is not affiliated with any of the entities whose students it serves. We are students and have written this project just for fun, as a minor QOL improvement in the morning.
+
+# Get Started
+## Requirements
+- [Schoology](https://www.schoology.com/) API creds
+- [PostgreSQL] 12+ installaton
+- - Database setup (see below)
+- [Python 3.8+](https://www.python.org/downloads/)
+
+## Config Files
+abSENT consists of 2 config files:
+- [```config.ini```]()
+- [```testing_config.ini```]()
+
+We've included templates for both of these files. Fill them in with the appropriate values.
+## Database Setup
+- Install and Setup PostgresSQL 12+
+- Create a new database called absent[^1]
+- Install [alembic](https://alembic.sqlalchemy.org/en/latest/)
+- Generate the tables using the following commands in shell:
+    - Run ```alembic revision --autogenerate -m 'initial'```
+    - Run ```alembic upgrade head```
+- The database should now be setup now!
+
+[^1]: You can call the database anything, but make sure to change the name in [```settings.py```](
+
+Notes: 
+- By default, abSENT uses a postgres DB caled absent, running on port 5432. If you encounter issues, try changing the server address and port in [```src/database/database.py```]()
+
+
+## Running it
+To run abSENT, run the following command in your terminal, in the root directry:
+
+```python -m src.dev```

config_template.ini

@@ -0,0 +1,21 @@
+; Template for config.ini
+
+[NNHS]
+    key = ; API key for schoology
+    secret = ; API secret for schoology
+
+[NSHS]
+    key = ; API key for schoology
+    secret = ; API secret for schoology
+
+[PostgreSQL]
+    name = ; database name
+    user = ; database user
+    password = ; database password
+
+[Firebase]
+    pkey = ; path to firebase service account json file
+
+[JWT]
+    pkey = ; path to private key for signing
+    pubkey = ; path to public key for verification

src/dev.py

@@ -1,3 +1,6 @@
+# Run 'python -m src.dev' to run this script
+# Must be run from root folder!
+
 import os
 import logging
 import sys

tests/tools/googleTokenGen.py

@@ -1,6 +1,6 @@
 from configparser import ConfigParser
 
-SECRETS_PATH = "tests/tools/secrets.ini"
+SECRETS_PATH = "tests/tools/testing_secrets.ini"
 
 configuer = ConfigParser()
 secrets = configuer.read(SECRETS_PATH)

tests/tools/secrets_template.ini

@@ -0,0 +1,10 @@
+; Secrets file for testing
+[Google]
+client_id = ; Google app client id
+client_secret = ; Google app client secret
+
+[Login]
+id_token = ; DO NOT FILL IN; will be auto generated by googleTokenGen.py
+token = ; DO NOT FILL IN; will be auto generated by googleTokenGen.py
+refresh_token = ; DO NOT FILL IN; will be auto generated by googleTokenGen.py
+