Merge pull request #25 from ComputerScienceHouse/docs

wilsonmcdade · web-flow · commit b002f5021a1f · 2023-03-11T00:41:33.000-05:00
Added Docs to README
diff --git a/README.md b/README.md
@@ -6,4 +6,47 @@ Front-end for the Devcade website that allows members to view the game catalog a
 
 `cd src`
 
-`flask run`
+`flask run`
+
+# Project Structure
+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).
+
+```
+devcade-website
+| src/
+| | static/         // Static content (images, css, js)
+| | templates/      // Header and content templates
+| | | header.html   // Includes game block macro and header block macro
+| | | game.html     // Game focus page
+| | | catalog.html  // Game catalog page
+| | | credits.html  // Game credits page (using game blocks)
+| | | error.html    // Error page
+| | | home.html     // Main page, includes project details
+| | | upload.html   // Game upload page, including instructions
+| | | profile.html  // User profile -- not implemented
+| app.py            // Main file
+| auth.py           // Helper functions for handling CSH auth
+| config.py         // Environment variable getters
+| init.py           // Initialization for flask project
+| models.py         // User model
+| envs.py           // Environment variable setters (Follows template described in Local Development section)
+```
+
+# Local Development
+If you would like to run this project using your local machine, first create a `envs.py` file with the following structure:
+
+```
+import os
+
+os.environ['SERVER_NAME'] = ''
+os.environ['PREFERRED_URL_SCHEME'] = ''
+os.environ["OIDC_CLIENT_SECRET"] = ""
+os.environ["DEVCADE_DB_PORT"] = ""
+os.environ["DEVCADE_DB_NAME"] = ""
+os.environ["DEVCADE_DB_USER"] = ""
+os.environ["DEVCADE_DB_PASS"] = ""
+os.environ["DEVCADE_DB_URI"] = ""
+os.environ["DEVCADE_API_URI"] = ""
+```
+
+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.
diff --git a/src/templates/header.html b/src/templates/header.html
@@ -13,7 +13,9 @@ <h3>{{ game.author }}</h3>
   </div>
 </a>
 {% endif %}
-{% endmacro %} {% block header %}
+{% endmacro %}
+
+{% block header %}
 <!DOCTYPE html>
 <html lang="en">
   <head>
