Skip to content

Commit

Permalink
issue #32: fix md lint errors + update testing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
k-allagbe committed Jan 23, 2024
1 parent e9aeda0 commit 74e3e3a
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
6 changes: 6 additions & 0 deletions TESTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Testing

Run:

```bash
python -m unittest discover -s tests
```
9 changes: 6 additions & 3 deletions docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Deployment

Note on the container: Create and set the environment variables based on `.env.template`. Make sure
`FINESSE_BACKEND_DEBUG_MODE` is NOT set to `True` in PRODUCTION builds.
Note on the container: Create and set the environment variables based on
`.env.template`. Make sure `FINESSE_BACKEND_DEBUG_MODE` is NOT set to `True` in
PRODUCTION builds.

Refer to the [infrastructure repository](https://github.com/ai-cfia/infra) for a Kubernetes deployment. The secrets (in this case environment variables) are managed with Hashicorp Vault.
Refer to the [infrastructure repository](https://github.com/ai-cfia/infra) for a
Kubernetes deployment. The secrets (in this case environment variables) are
managed with Hashicorp Vault.
28 changes: 14 additions & 14 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

1. Clone the repository:

```bash
git clone https://github.com/ai-cfia/finesse-backend.git
```
```bash
git clone https://github.com/ai-cfia/finesse-backend.git
```

2. Open in devcontainer.

Alternatively,

1. Clone the repository:

```bash
git clone https://github.com/ai-cfia/finesse-backend.git
cd finesse-frontend
```
```bash
git clone https://github.com/ai-cfia/finesse-backend.git
cd finesse-frontend
```

2. Create a virtual environment:

```bash
python -m venv venv
source venv/bin/activate
```
```bash
python -m venv venv
source venv/bin/activate
```

3. Install the dependencies:

```bash
pip install -r requirements.txt
```
```bash
pip install -r requirements.txt
```
10 changes: 6 additions & 4 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

## With your local environment

Create and set the environment variables based on `.env.template`. You will need to create a `.env` file.
Create and set the environment variables based on `.env.template`. You will need
to create a `.env` file.

### Running:
### Running

```bash
flask run -h 0.0.0.0 --debug
```

Alternatively, set the `FINESSE_BACKEND_DEBUG_MODE` environment variable to
Alternatively, set the `FINESSE_BACKEND_DEBUG_MODE` environment variable to
`True` and run:

```bash
Expand All @@ -19,7 +20,8 @@ python run.py

## With docker

Create and set the environment variables based on `.env.template`. You will need to create a `.env` file.
Create and set the environment variables based on `.env.template`. You will need
to create a `.env` file.

Build the container:

Expand Down

0 comments on commit 74e3e3a

Please sign in to comment.