Skip to content

Commit 4b80916

Browse files
author
Emile Frey
committed
updated readme
1 parent 571fb29 commit 4b80916

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Install Docker Desktop
77

88
There are 3 .env files provided. Note in particular the .env files in backend/ and postgres/; there, you can adjust the database credentials, debug mode, secret key, allowed hosts, etc. But things should run just fine without any changes, but just know these files are there.
99

10+
The included sample prediction django app can be easily removed by removing 'prediction' from INSTALLED_APPS in django mainapp/settings.py, removing the associated path in mainapp/urls.py and deleting the entire prediction folder. Additionally, you should remove pandas, scikit-learn, and joblib from backend/requirements.txt. On the frontend, delete/replace the contents of Home.tsx.
11+
12+
Change the boilerplate app name (shown in header and footer) by changing the constant APP_NAME in frontend/src/settings.tsx.
13+
1014
**_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._**
1115

1216

@@ -23,7 +27,6 @@ docker-compose -f "docker-compose.yml" up -d --build
2327
```
2428
The server should be available at `http://127.0.0.1/`. This mode will not hot reload since it's running a production build.
2529

26-
The included sample prediction django app can be easily removed by removing 'prediction' from INSTALLED_APPS in django mainapp/settings.py, removing the associated path in mainapp/urls.py and deleting the entire prediction folder.
2730

2831
The Material UI Theme can be adjusted in frontend\src\Theme.tsx
2932

0 commit comments

Comments
 (0)