Skip to content

Commit

Permalink
feat: added README.md (#306)
Browse files Browse the repository at this point in the history
* feat: added README.md

* feat: added W503 line break before binary operator ignore
  • Loading branch information
loboda4450 authored Sep 5, 2024
1 parent 923cf3c commit 102d3ee
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions console/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Voltaserve Console API

## Getting Started

Install dependencies:

```shell
poetry install --no-interaction --no-cache
```

Activate the virtual environment created by Poetry:

```shell
source /home/your_user/.cache/pypoetry/virtualenvs/voltaserve-console-something/bin/activate
```

Run:

```shell
poetry run python -m api.uvi
```

Lint code:

```shell
flake8 . --extend-ignore F401,W291,W503 --max-line-length 120 --extend-exclude Dockerfile
```

Format code:

```shell
black .
```

0 comments on commit 102d3ee

Please sign in to comment.