You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* fix evals stuff
Spring evals errors
Housing point stuff
* update some important documentationy bits
* fixed migration
---------
Co-authored-by: Tyler Allen <tyler@tallen.me>
Copy file name to clipboardExpand all lines: README.md
+48-47Lines changed: 48 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,45 +8,23 @@ A comprehensive membership evaluations solution for Computer Science House.
8
8
Development
9
9
-----------
10
10
11
-
### Config
11
+
##Running (containerized)
12
12
13
-
You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.env.py` for an example.
14
-
15
-
#### Add OIDC Config
16
-
Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
An S3 bucket is used to store files that users upload (currently just for major project submissions). In order to have this work properly, you need to provide some credentials to the app.
13
+
It is likely easier to use containers like `podman` or `docker` or the corresponding compose file
29
14
30
-
There are 2 ways that you can get the needed credentials.
31
-
1. Reach out to an RTP for creds to the dev bucket
32
-
2. Create your own bucket using [DEaDASS](https://deadass.csh.rit.edu/), and the site will give you the credentials you need.
You can either develop using the dev database, or use the local database provided in the docker compose file
43
-
44
-
Using the local database is detailed below, but both options will require the dev database password, so you will have to ask an RTP for this too
45
-
46
-
#### Forcing evals/rtp or anything else
47
-
All of the role checking is done in `conditional/utils/user_dict.py`, and you can change the various functions to `return True` for debugging
21
+
If you want, you can run without auto rebuild using
22
+
```sh
23
+
podman compose up --force-recreate --build
24
+
```
25
+
Which can be restarted every time changes are made.
48
26
49
-
###Run (Without Docker)
27
+
## Run (Without Docker)
50
28
51
29
To run the application without using containers, you must have the latest version of [Python 3](https://www.python.org/downloads/) and [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) installed. Once you have those installed, create a new virtualenv and install the Python dependencies:
52
30
@@ -90,30 +68,53 @@ or
90
68
python -m gunicorn
91
69
```
92
70
93
-
### Run (containerized)
71
+
##Config
94
72
95
-
It is likely easier to use containers like `podman` or `docker` or the corresponding compose file
96
-
97
-
With podman, I have been using
73
+
You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.env.py` for an example.
98
74
99
-
```sh
100
-
podman compose up --watch
75
+
### Add OIDC Config
76
+
Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
If you want, you can run without compose support using
104
-
```sh
105
-
podman compose up --force-recreate --build
87
+
### Add S3 Config
88
+
An S3 bucket is used to store files that users upload (currently just for major project submissions). In order to have this work properly, you need to provide some credentials to the app.
89
+
90
+
There are 2 ways that you can get the needed credentials.
91
+
1. Reach out to an RTP for creds to the dev bucket
92
+
2. Create your own bucket using [DEaDASS](https://deadass.csh.rit.edu/), and the site will give you the credentials you need.
Which can be restarted every time changes are made
101
+
### Database
102
+
You can either develop using the dev database, or use the local database provided in the docker compose file
103
+
104
+
Using the local database is detailed below, but both options will require the dev database password, so you will have to ask an RTP for this too
105
+
106
+
### Forcing evals/rtp or anything else
107
+
All of the role checking is done in `conditional/utils/user_dict.py`, and you can change the various functions to `return True` for debugging
108
+
109
+
109
110
110
-
###Dependencies
111
+
## Dependencies
111
112
112
113
To add new dependencies, add them to `requirements.in` and then run `pip-compile requirements.in` to produce a new locked `requirements.txt`. Do not edit `requirements.txt` directly as it will be overwritten by future PRs.
113
114
114
-
###Database Stuff
115
+
## Database Stuff
115
116
116
-
####Local database
117
+
### Local database
117
118
118
119
You can run the database locally using the docker compose
119
120
@@ -130,7 +131,7 @@ To run migration commands in the local database, you can run the commands inside
130
131
podman exec conditional flask db upgrade
131
132
```
132
133
133
-
####Database Migrations
134
+
### Database Migrations
134
135
135
136
If the database schema is changed after initializing the database, you must migrate it to the new schema by running:
0 commit comments