Flask-Project-Template/README.md

28 lines
1.0 KiB
Markdown
Raw Normal View History

2019-11-01 22:54:25 +00:00
# Flask-Project-Template
2021-09-26 23:27:47 +00:00
A template to quickly standup a Flask app with Bootstrap 5, React, OIDC IAM, and a database.
2019-11-01 22:54:25 +00:00
# Dependencies
``` sudo apt install python3 ```
# Setup
2020-10-31 01:32:26 +00:00
*** Change directory to Flask-Project-Template/ or rename the folder before doing so. Then either run the create_venv.sh script. For windows, you'll need git bash. You can also just create the venv yourself and pip install the dependencies thereafter.
2019-11-01 22:54:25 +00:00
2020-10-31 01:32:26 +00:00
*** To start the application:
2020-02-24 05:45:27 +00:00
Linux/Mac
``` ./linux-start.sh ```
2020-02-24 05:45:27 +00:00
Windows
``` ./windows-start.sh ```
2020-02-24 05:45:27 +00:00
2019-11-01 22:54:25 +00:00
2020-12-16 05:36:54 +00:00
# Images
![1 Default starting interface. ](images/pic1.png)
2019-11-01 22:54:25 +00:00
# Notes
2020-10-31 01:32:26 +00:00
* Make sure to change the port in the start script as needed.
* You can change the login route by changing the 'LOGIN_PATH' variable in the __init__.py file in the 'core' directory.
* Get [Keycloak](https://www.keycloak.org) to use oidc login route.
* If using Keycloak, make sure to change the client_secrets.json file values to match your Keycloak settings. Or, match Keycloak settings to the client_secrets.json file.
* Have fun!