-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,27 @@ | ||
| # Contribution | ||
|
|
||
| ## Dependencies | ||
| ```bash | ||
| # Install all the dependencies. | ||
| pipenv sync | ||
| # Update dependencies. | ||
| pipenv install | ||
| ``` | ||
| # backend | ||
|
|
||
| ## Development | ||
| Leverages great things to achieve great results | ||
|
|
||
| If you want to link to Postgresql, create the `.env` file and set the `POSTGRES_URI` environment variable in it, example: | ||
| [](https://www.codefactor.io/repository/github/openzim/nautilus-webui) | ||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
| [](https://codecov.io/gh/openzim/nautilus-webui) | ||
|  | ||
|
|
||
| ```env | ||
| POSTGRES_URI=postgresql+psycopg://username:password@host/database | ||
| ``` | ||
|
|
||
| Dev commands: | ||
| ```bash | ||
| # Init database | ||
| pipenv run init | ||
| # Start FastAPI | ||
| pipenv run start | ||
| # Run tests | ||
| pipenv run tests | ||
| # Format code | ||
| pipenv run format | ||
| # Check format. | ||
| pipenv run format:check | ||
| ## Usage | ||
|
|
||
| **CAUTION**: this is not a standalone, installable Python package. | ||
|
|
||
| - It's the backend of a web service that is intended to be deployed using OCI images. | ||
| - See the sample Composefile in the dev folder of the repository. | ||
| - It has external dependencies (including [S3 Storage](https://wasabi.com/), [Mailgun](https://www.mailgun.com/) account and a full-fledged [Zimfarm](https://github.com/openzim/zimfarm). | ||
| - It **must be configured** via environment variables (see `constants.py` and Compose's Envfile) | ||
| - There is no CHANGELOG nor release management. Production is tied to CD on `main` branch. | ||
|
|
||
| ```sh | ||
| ❯ hatch run serve | ||
| ``` | ||
|
|
||
| nautilus-webui backend adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing). | ||
|
|
||
| nautilus-webui backend has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/docs/Policy.md) **v1.0.1**. |