From 40cf9121b675a2a94b7a72aabb4c8cdea5c56cf4 Mon Sep 17 00:00:00 2001 From: Aarni Halinen Date: Sat, 6 Aug 2022 16:35:58 +0300 Subject: [PATCH] Clean-up README and coveragerc --- .coveragerc | 4 ---- README.md | 34 +++++++++++----------------------- 2 files changed, 11 insertions(+), 27 deletions(-) diff --git a/.coveragerc b/.coveragerc index 81ae08a..4a08d6a 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,9 +1,5 @@ [report] show_missing = True -omit = - */migrations/* - */admin.py - */translation.py [run] omit = */migrations/* diff --git a/README.md b/README.md index 2394ee9..f6b3eb0 100644 --- a/README.md +++ b/README.md @@ -32,34 +32,26 @@ git checkout develop ### 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 -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 -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). @@ -79,19 +71,15 @@ python manage.py createdummydata # creates dummy members to the member regis ### Running ```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 [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`.