Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
slimovich committed Jun 26, 2020
1 parent 185859f commit 3a21cf5
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
> ### 🛠 Status: WIP
>
> *Under developement, WIP. Be patient.*
![Build](https://github.com/slimovich/fastapi-gino-postgresql-template/workflows/Build/badge.svg)

*Under developement, WIP. Be patient.*
A real wolrd template project using Fastapi framework as well as a full implementation of CI/CD

Overview
----------
Expand Down Expand Up @@ -33,6 +37,7 @@ pip install pipenv
```bash
PIPENV_DOTENV_LOCATION=local.env pipenv run make install-dev-deps
```
The command above will install for you a separate environnement and installing all dependencies
- run unit test
```bash
PIPENV_DOTENV_LOCATION=local.env pipenv run make test
Expand All @@ -44,7 +49,29 @@ PIPENV_DOTENV_LOCATION=local.env pipenv run make run

Deployment with Docker
----------------------
TODO
You must have docker and docker-compose tools installed in your system. Then just run:

```bash
make build-dev
make run-dev-containers
```

This will build the images and run 3 containers (Fastapi application, PostgreSQL, PGAdmin 4) in developement environnement.

If you want to run the containers in production environnement, you can do the following:

```bash
make build-prod
make run-prod-containers
```

Your can find the files to configure each environnement in the root directory:
- env-develop.env
- env-production.env

Application will be available on localhost in your browser.

All routes are available on /docs paths with Swagger

Sonar Qube
----------------------
Expand Down

0 comments on commit 3a21cf5

Please sign in to comment.