https://github.com/se-sustainability-oss/ecodev-app
modern python web application template: FastAPI/SQLModel for the backend, Dash for the frontend, docker/docker-compose for the infra
https://github.com/se-sustainability-oss/ecodev-app
dash docker docker-compose fastapi python sqlmodel
Last synced: 2 months ago
JSON representation
modern python web application template: FastAPI/SQLModel for the backend, Dash for the frontend, docker/docker-compose for the infra
- Host: GitHub
- URL: https://github.com/se-sustainability-oss/ecodev-app
- Owner: SE-Sustainability-OSS
- License: mit
- Created: 2024-02-01T13:26:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-29T14:24:14.000Z (5 months ago)
- Last Synced: 2025-03-25T16:21:20.528Z (3 months ago)
- Topics: dash, docker, docker-compose, fastapi, python, sqlmodel
- Language: Python
- Homepage: https://ecodev-doc.lcabox.com/cookiecutters/app/
- Size: 351 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README-template.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# MY-APP-NAME
_Description of my app_
### Usage
Go to `` to view the app.
Got to `/docs` to view the API documentation (with Swagger)
### Local development
1. Clone the repo and build the docker image:
```git
git clone [email protected]:FR-PAR-ECOACT/.git
```
2. Create an `.env` file and save it under the application's root folder. It must contain the following (you have an `env_template` to help you):
```.env
# App name
app_name= My New App # Name of the app. Will appear on the app header.
# API app
app_port=8000 # API app port number. Remove this entry in production
fastapi_url= # API app web url. Fill only in production.
# Dash app
dash_app_port=8050 # Dash app port number. Remove this entry in production
dash_url= # Dash app web url. Fill only in production.
# Jupyter app
jupyter_port=5000 # Jupyter notebook port number. Remove this entry in production
# Database access
db_port=5432 # Database port number
db_host=db # Database server name
db_name=db # Database name
db_username=user # Database login username. Change to a real username.
db_password=password # Database login password. Change to a secured password.
# Hashing secrets
secret_key=abcdefghijklmnopqrstuvwxyz134567890 # App secret key (for hashing purposed)
algorithm=HS256 # Password hashing algorithm
# Other
access_token_expire_minutes=1440 # App JWT access token expiry duration
# App mailbox
email_sender= # Mailbox email address. Put to the real email sender
email_password= # Mailbox password. Put to the real email sender password
email_smtp= # Mailbox SMTP (like smtp.gmail.com or mail.outlook.com). Put your smtp provider here
# gunicorn/uvicorn setup
gunicorn_setup=false # Should be True in production. Simpler to only with uvicorn for local dev
debug=false # Put to true if you want to be in dash debug mode
```
3. Run `make setup` to install the pre-commits
4. Build the docker image
```bash
make dev-build
```
5. Open your [local PGAdmin](http://localhost:5054) and login using the admin credentials.
⚠️ You may encounter login issues if using Firefox browser.
6. Connect to the database server using the admin credentials
7. Create a new database `_db`, as per your .env file (`db`) in the example.
8. Add a user.json file under data, if you'd like to initialise a few users. It should contain:
```json
[
{
"id": null,
"user": "user_name",
"password": "hashed_password",
"permission": "permission_level",
"client": "project_name",
"application": "application_name"
}
]
```
9. Run the docker container
```bash
docker compose up -d
```
10. The app should be running under http://localhost: :
10. To check for any issues, you can check the logs with:
```bash
docker logs --tail=100 -f
```
Use `Ctrl+C` to exit the logs