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
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@ Front-end for the Devcade website that allows members to view the game catalog a
9
9
`flask run`
10
10
11
11
# Project Structure
12
+
This project follows a standard template for a Flask project. Below is the basic file structure of the project, with every file described other than those in the `static/` folder (for brevity).
12
13
13
14
```
14
15
devcade-website
@@ -25,7 +26,27 @@ devcade-website
25
26
| | | profile.html // User profile -- not implemented
26
27
| app.py // Main file
27
28
| auth.py // Helper functions for handling CSH auth
28
-
| config.py // Environ variable loaders
29
+
| config.py // Environment variable getters
29
30
| init.py // Initialization for flask project
30
31
| models.py // User model
31
-
```
32
+
| envs.py // Environment variable setters (Follows template described in Local Development section)
33
+
```
34
+
35
+
# Local Development
36
+
If you would like to run this project using your local machine, first create a `envs.py` file with the following structure:
37
+
38
+
```
39
+
import os
40
+
41
+
os.environ['SERVER_NAME'] = ''
42
+
os.environ['PREFERRED_URL_SCHEME'] = ''
43
+
os.environ["OIDC_CLIENT_SECRET"] = ""
44
+
os.environ["DEVCADE_DB_PORT"] = ""
45
+
os.environ["DEVCADE_DB_NAME"] = ""
46
+
os.environ["DEVCADE_DB_USER"] = ""
47
+
os.environ["DEVCADE_DB_PASS"] = ""
48
+
os.environ["DEVCADE_DB_URI"] = ""
49
+
os.environ["DEVCADE_API_URI"] = ""
50
+
```
51
+
52
+
Note that this is just a template for the `envs.py` file. You will need to get these secrets from an RTP or Devcade developer.
0 commit comments