@@ -15,16 +15,17 @@ To run the application you need:
From the root directory of the repository:
```bash
docker-compose build
docker-compose up
```
> 💬 *If you run the application for the first time, you will need to create the database depending on the name of your `DATABASE_NAME` env variable (`fastgenes` being the default value). [[More information below](#-create-your-db-on-postgresql)]*.
Then you can visit the [documentation](http://localhost/docs) of the project.
Then you can visit the [app](http://localhost) and the [documentation](http://localhost/docs) of the project.
### 📄 `.env`
> 💬 *This file allows use to deal with environment variable.*
> 💬 *This file allows user to deal with environment variable.*
Example of the different env variable is available:
...
...
@@ -32,6 +33,8 @@ Example of the different env variable is available:
If you remove the `.sample` extension to the file, the `.env` is read by the backend application.
The full list of Environment variables used by the application can be found at `app/app/core/config.py`.
-------
# 📝 Development & Contributions
...
...
@@ -92,6 +95,8 @@ exit
You can create a test database using the API directly and some test files available on the repository.
> 💬 *You can use directly the [documentation page](http://localhost/docs) to run the different commands.*
Title | route | input path
----- | ----- | ----------
Create KEGG database | `/api/admin_db/create_kegg_ko` | no input file necessary, process is quick for all KEGG KO.
