Commit e145d713 authored by Kenzo-Hugo Hillion's avatar Kenzo-Hugo Hillion
Browse files

update README

parent 4a4489c8
Pipeline #12695 passed with stage
in 1 minute and 4 seconds
......@@ -3,23 +3,30 @@
[![pipeline status](https://gitlab.pasteur.fr/metagenomics/metagenedb/badges/master/pipeline.svg)](https://gitlab.pasteur.fr/metagenomics/metagenedb/commits/master)
[![coverage report](https://gitlab.pasteur.fr/metagenomics/metagenedb/badges/master/coverage.svg)](https://gitlab.pasteur.fr/metagenomics/metagenedb/commits/master)
Django based project to build metagenomics genes catalog and tools
Django based project to build genes catalog and tools
to play with it and contact external services.
## Run the services on your local machine
### First usage
### Prerequisites
#### Settings for Django server
#### Dependencies
As you can see, there is not a single `settings.py` file for the Django project but instead
several settings files that are located in the `settings` directory which is supposed to be a module.
Therefore, you need to add an `__init__.py` to this module and specify which settings you want to import.
For instance, if you want to have the development settings, configure the `__init__.py`:
The application depends on different services that run independently on docker images and all of this is
orchestrated by `docker-compose`.
```python
from .development import *
```
Therefore to run the application you need:
This is to allow different settings depending your environment. You can also keep all your credentials
in this `__init__.py` file.
\ No newline at end of file
* `Docker` : [Install instructions](https://docs.docker.com/install/)
* `Docker Compose` : [Install instructions](https://docs.docker.com/compose/install/)
#### Configuration
The settings of the Django server is based on the `backend/.env` file. You can copy the sample file
(`cp backend/.env.sample backend/.env`) and fill in the variables.
You can of course customize more of the Django server settings in the `settings` module of metagenedb.
### Run the application
#### Populate the database
\ No newline at end of file
DEBUG=True
SECRET_KEY="your secret"
DATABASES_HOST=db
DATABASES_POSTGRES_PORT=5432
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment