Skip to content

Commit 47466ce

Browse files
author
Emile Frey
committed
updated README
1 parent 7ac5b56 commit 47466ce

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ You shouldn't have to make any changes to get this up and running, but here's so
1313

1414
- The included sample helloyou django app can be easily removed by removing 'helloyou' from INSTALLED_APPS in django mainapp/settings.py, removing the associated helloyou path in mainapp/urls.py and deleting the entire helloyou folder. There are no database migrations, so you don't need to worry about that. On the frontend, delete/replace the contents of Home.tsx.
1515

16-
- You can change the boilerplate app name (shown at login, header, and footer) by changing the constant APP_NAME in frontend/src/settings.tsx.
17-
18-
- 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.
16+
## Running
1917

20-
- The Material UI Theme can be adjusted in frontend\src\Theme.tsx
21-
22-
- An alert setter at the context level is also included. An example of TriggerAlert is shown in Home.tsx (displayed after successful submit). See AlertContext.tsx for typings.
2318

2419
**_NOTE: If you change your database name/credentials, but have already run the steps below, you may need to delete the associated postgres docker image in order to get things to work._**
2520

@@ -36,16 +31,28 @@ docker-compose -f "docker-compose.yml" up -d --build
3631
```
3732
The server should be available at `http://127.0.0.1/`. This mode will not hot reload since it's running a production build (npm build).
3833

39-
The password reset feature is fully functional. In order to get the password reset url, you will need to open the backend django console. Enter the following in an application like PowerShell:
4034

41-
```sh
42-
$id = $(docker ps -aqf "name=django-react-postgres-boilerplate_backend")
43-
docker logs --tail 1000 -f $id
44-
```
35+
## Features
36+
### Forgot Password:
37+
- The password reset feature is fully functional. In order to get the password reset url, you will need to open the backend django console. Enter the following in an application like PowerShell:
38+
```sh
39+
$id = $(docker ps -aqf "name=django-react-postgres-boilerplate_backend")
40+
docker logs --tail 1000 -f $id
41+
```
42+
- Upon submitting a valid email, you should get a path like http://localhost:300/password_reset?token=abcdefgxyz123; paste this in your browser to access the password reset form. The password reset form first validates the token; if the token is valid, it presents the password reset interface and allows the user to provide a new password.
43+
44+
Check out the Django docs starting [here](https://docs.djangoproject.com/en/3.1/topics/email/#smtp-backend) in order to update the Email Backend from a console output to an actual SMTP backend.
4545

46-
Upon submitting a valid email, you should get a path like http://localhost:300/password_reset?token=abcdefgxyz123; paste this in your browser to access the password reset form. The password reset form first validates the token; if the token is valid, it presents the password reset interface and allows the user to provide a new password.
46+
### Left Navigation Bar:
47+
- 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.
48+
### Alerts:
49+
- An alert setter at the context level is also included. An example of TriggerAlert is shown in Home.tsx (displayed after successful submit). See AlertContext.tsx for typings.
50+
51+
### Customization:
52+
- You can change the boilerplate app name (shown at login, header, and footer) by changing the constant APP_NAME in frontend/src/settings.tsx.
53+
- The Material UI Theme can be adjusted in frontend\src\Theme.tsx
4754
48-
Check out the Django docs starting [here](https://docs.djangoproject.com/en/3.1/topics/email/#smtp-backend) in order to update the Email Backend from a console output to an actual SMTP backend.
55+
###
4956
5057
**_Suggestions/feedback in discussions tab are greatly appreciated._**
5158

0 commit comments

Comments
 (0)