Skip to content

Commit 871474e

Browse files
committed
Added Local Development Section to readme
1 parent 2d76a55 commit 871474e

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Front-end for the Devcade website that allows members to view the game catalog a
99
`flask run`
1010

1111
# 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).
1213

1314
```
1415
devcade-website
@@ -25,7 +26,27 @@ devcade-website
2526
| | | profile.html // User profile -- not implemented
2627
| app.py // Main file
2728
| auth.py // Helper functions for handling CSH auth
28-
| config.py // Environ variable loaders
29+
| config.py // Environment variable getters
2930
| init.py // Initialization for flask project
3031
| 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

Comments
 (0)