Skip to content

Commit 2d76a55

Browse files
committed
Added project structure, local development sections to the README
1 parent fc15766 commit 2d76a55

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,26 @@ Front-end for the Devcade website that allows members to view the game catalog a
66

77
`cd src`
88

9-
`flask run`
9+
`flask run`
10+
11+
# Project Structure
12+
13+
```
14+
devcade-website
15+
| src/
16+
| | static/ // Static content (images, css, js)
17+
| | templates/ // Header and content templates
18+
| | | header.html // Includes game block macro and header block macro
19+
| | | game.html // Game focus page
20+
| | | catalog.html // Game catalog page
21+
| | | credits.html // Game credits page (using game blocks)
22+
| | | error.html // Error page
23+
| | | home.html // Main page, includes project details
24+
| | | upload.html // Game upload page, including instructions
25+
| | | profile.html // User profile -- not implemented
26+
| app.py // Main file
27+
| auth.py // Helper functions for handling CSH auth
28+
| config.py // Environ variable loaders
29+
| init.py // Initialization for flask project
30+
| models.py // User model
31+
```

0 commit comments

Comments
 (0)