Skip to content

Commit 291c5fc

Browse files
Update dependencies
1 parent fc37777 commit 291c5fc

File tree

3 files changed

+380
-295
lines changed

3 files changed

+380
-295
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ package-lock.json
1111
package.json
1212
.specstory
1313
.cursorrules
14-
.cursor
14+
.cursor
15+
repomix-output.txt
16+
artifacts/

docs/customization.qmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ We also create POST endpoints, which accept form submissions so the user can cre
7171

7272
#### Customizable folders and files
7373

74-
- FastAPI application entry point: `main.py`
75-
- FastAPI routes: `routers/`
76-
- User authentication endpoints: `account.py`
74+
- FastAPI application entry point and homepage GET route: `main.py`
75+
- FastAPI POST routes: `routers/`
76+
- User authentication endpoints: `authentication.py`
7777
- User profile management endpoints: `user.py`
7878
- Organization management endpoints: `organization.py`
7979
- Role management endpoints: `role.py`
@@ -106,6 +106,8 @@ Most everything else is auto-generated and should not be manually modified.
106106

107107
### Code conventions
108108

109+
The GET route for the homepage is defined in the main entry point for the application, `main.py`. The entrypoint imports router modules from the `routers/` directory, which contain the other GET and POST routes for the application. In CRUD style, the router modules are named after the resource they manage, e.g., `account.py` for account management.
110+
109111
We name our GET routes using the convention `read_<name>`, where `<name>` is the name of the page, to indicate that they are read-only endpoints that do not modify the database. In POST routes that modify the database, you can use the `get_session` dependency as an argument to get a database session.
110112

111113
Routes that require authentication generally take the `get_authenticated_account` dependency as an argument. Unauthenticated GET routes generally take the `get_optional_user` dependency as an argument. If a route should *only* be seen by authenticated users (i.e., a login page), you can redirect to the dashboard if `get_optional_user` returns a `User` object.

0 commit comments

Comments
 (0)