update readme

This commit is contained in:
Aarni Halinen
2022-01-13 22:38:50 +02:00
parent 49a3b1449e
commit 9cae6ea890
+23 -11
View File
@@ -32,26 +32,34 @@ git checkout develop
### Poetry
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
For depedencies and virtual environment, we use [poetry](https://python-poetry.org/).
```bash
poetry config virtualenvs.in-project true
python3 -m pip install poetry
```
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
Activate virtual environment in shell
```bash
python3 -m poetry shell
```
Install dependencies
```bash
poetry install
```
Activate virtual environment in shell
```bash
poetry shell
```
### 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).
@@ -71,15 +79,19 @@ python manage.py createdummydata # creates dummy members to the member regis
### Running
```bash
python manage.py runserver 0.0.0.0:8000
python manage.py runserver
```
Using address `0.0.0.0` will bind to all IP addresses. Using `localhost` will only bind to your machine.
#### Visit the page
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
When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with `feature`.