Clean-up README and coveragerc
This commit is contained in:
@@ -1,9 +1,5 @@
|
|||||||
[report]
|
[report]
|
||||||
show_missing = True
|
show_missing = True
|
||||||
omit =
|
|
||||||
*/migrations/*
|
|
||||||
*/admin.py
|
|
||||||
*/translation.py
|
|
||||||
[run]
|
[run]
|
||||||
omit =
|
omit =
|
||||||
*/migrations/*
|
*/migrations/*
|
||||||
|
|||||||
@@ -32,34 +32,26 @@ git checkout develop
|
|||||||
|
|
||||||
### Poetry
|
### Poetry
|
||||||
|
|
||||||
For depedencies and virtual environment, we use [poetry](https://python-poetry.org/).
|
For depedencies and virtual environment, we use [poetry](https://python-poetry.org/). The easiest integration with VSCode is to have poetry install virtual environment in project folder, configured with
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 -m pip install poetry
|
poetry config virtualenvs.in-project true
|
||||||
```
|
```
|
||||||
|
|
||||||
The easiest integration with VSCode is to have poetry install virtual environment in project folder, configured with CMD
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 -m poetry config virtualenvs.in-project true
|
|
||||||
```
|
|
||||||
|
|
||||||
Start developing by install dependencies first
|
|
||||||
|
|
||||||
#### CMDs
|
#### CMDs
|
||||||
|
|
||||||
Activate virtual environment in shell
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 -m poetry shell
|
|
||||||
```
|
|
||||||
|
|
||||||
Install dependencies
|
Install dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
poetry install
|
poetry install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Activate virtual environment in shell
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry shell
|
||||||
|
```
|
||||||
|
|
||||||
### npm scripts
|
### npm scripts
|
||||||
|
|
||||||
We use Node.js for few development tasks, like linting. Easiest way to install Node is [nvm](https://github.com/nvm-sh/nvm).
|
We use Node.js for few development tasks, like linting. Easiest way to install Node is [nvm](https://github.com/nvm-sh/nvm).
|
||||||
@@ -79,19 +71,15 @@ python manage.py createdummydata # creates dummy members to the member regis
|
|||||||
### Running
|
### Running
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python manage.py runserver
|
python manage.py runserver 0.0.0.0:8000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Using address `0.0.0.0` will bind to all IP addresses. Using `localhost` will only bind to your machine.
|
||||||
|
|
||||||
#### Visit the page
|
#### Visit the page
|
||||||
|
|
||||||
Visit [https://localhost:8000](https://localhost:8000) in your browser!
|
Visit [https://localhost:8000](https://localhost:8000) in your browser!
|
||||||
|
|
||||||
Using address `0.0.0.0` will bind to all IP addresses. Using `localhost` will only bind to your machine.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python manage.py runserver 0.0.0.0:8000
|
|
||||||
```
|
|
||||||
|
|
||||||
### Development workflow
|
### Development workflow
|
||||||
|
|
||||||
When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with `feature`.
|
When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with `feature`.
|
||||||
|
|||||||
Reference in New Issue
Block a user