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
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# django-react-postgres-boilerplate
1
+
# StarterApp
2
2
3
3
## Prerequisites
4
4
Install Docker Desktop
@@ -7,7 +7,7 @@ Install Docker Desktop
7
7
8
8
**_Make sure backend\entrypoint.sh has LF format and not CRLF format_**
9
9
10
-
You shouldn't have to make any changes to get this up and running, but here's some things to note:
10
+
You shouldn't have to make any other changes to get this up and running, but here's some things to note:
11
11
12
12
- The default login credentials are admin and admin_password. These can be changed in backend/.env.
13
13
@@ -47,11 +47,15 @@ The server should be available at `http://127.0.0.1/`. This mode will not hot re
47
47
48
48
### Left Navigation Bar:
49
49
- The left navigation bar (intially shown on the left with only the Home icon upon login) is auto-generated along with the associated React Router's private routes. These routes can be easily added/modified in routes/Routes.ts.
50
+
51
+
### Subroutes/Params:
52
+
- There is a dummy component called Placeholder that gives an example on how to access parameters passed into the url. This is useful when ensuring the user can access a specific page given say a object's PK...even if the page is refreshed. See routes.ts on how to setup the routes to accept optional parameters in the url path.
53
+
50
54
### Alerts:
51
55
- An alert setter at the context level is also included. An example of TriggerAlert is shown in Home.tsx (variants displayed after successful/failed submit). See AlertContext.tsx for typings.
52
56
53
57
### Customization:
54
-
- The boilerplate app name (shown at login, header, and footer) by changing the constant APP_NAME in frontend/src/settings.tsx.
58
+
- The app name (shown at login&header) is set by the constant APP_NAME in frontend/src/settings.tsx.
55
59
- The default session duration is set to 5 hours in frontend/src/settings.tsx. The user will be logged out after 5 hours.
56
60
- The Material UI Theme can be adjusted in frontend\src\Theme.tsx
57
61
@@ -69,15 +73,13 @@ The server should be available at `http://127.0.0.1/`. This mode will not hot re
69
73
- [x] ensure a non-existing route redirects to home
70
74
- [x] email support (for password reset)
71
75
- [x] forgot password functionality (email)
72
-
- [ ] Add support for nested sub-routes off the main left-nav routes
76
+
- [x] Add support for nested sub-routes off the main left-nav routes
77
+
- [x] Ensure match params (i.e. /user/profile/1/) work correctly.
73
78
- [ ] Reset session timeout with activity.
74
79
- [ ] Context level modal?
75
80
- [ ] Swagger API Explorer
76
81
- [ ] Backend Testing
77
82
- [ ] Frontend Testing (React Testing Library)
78
83
- [ ] Auto redirect to login with Failed Request
79
84
- [ ] Axios Interface for demo API
80
-
- [ ] Update and Pin versions (remove anything unused)
81
-
- [ ] Logging (user login/logout)
82
-
- [ ] Company Name/App Name
83
-
- [ ] Docusaurus help
85
+
- [ ] Update and Pin versions (remove anything unused)
0 commit comments