Skip to content

Commit

Permalink
fix: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vugonz committed Nov 15, 2024
1 parent 9c005d8 commit cc62ece
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ These will only be necessary if you'll be using the `flask create-admin` command
- `ADMIN_PASSWORD`: Admin password


**Note**: If you use `docker compose` you will either need the `.env` file or environment variables set (no default values will be used) because `docker compose` will use use them to mount the correct volumes.
**Note**: If you use `docker compose` you will either need the `.env` file or environment variables set (no default values will be used) because `docker compose` will need them to mount the correct volumes.

## Project Structure
The project follows a layered architecture with a controller, service and models layer.
Expand Down Expand Up @@ -143,6 +143,8 @@ The structure is based on the Flask [factory extension pattern](https://flask.pa
├── data/ # application files
│ └── roles.json # roles configuration file
├── migrations/ # migration files (alembic)
└── tests/ # components tests
├── models/
Expand All @@ -152,7 +154,7 @@ The structure is based on the Flask [factory extension pattern](https://flask.pa
## Testing
To test run the following in the root directory of the repository:
```bash
python -m unittests -s discover
python -m unittest discover -s tests
```

## Endpoints
Expand Down

0 comments on commit cc62ece

Please sign in to comment.