Add dev dependencies: linters, formatters, testing
This commit is contained in:
parent
51504c74f7
commit
bde68c763e
3 changed files with 432 additions and 1 deletions
23
README.md
23
README.md
|
@ -7,9 +7,30 @@ The Servala Self-Service Portal
|
|||
Use ``uv`` to install the project and run its commands while you’re developing:
|
||||
|
||||
```bash
|
||||
uv sync
|
||||
uv sync --dev
|
||||
uv run src/manage.py migrate
|
||||
uv run src/manage.py runserver
|
||||
```
|
||||
|
||||
This will start the development server on http://localhost:8000.
|
||||
|
||||
### Configuration
|
||||
|
||||
TODO
|
||||
|
||||
### Code style and linting
|
||||
|
||||
Servala uses several linters / formatters to keep the project style consistent for you.
|
||||
Run them like this:
|
||||
|
||||
```bash
|
||||
uv run black src/ # Code formatting; -c to just check
|
||||
uv run isort src/ # Import ordering; -c to just check
|
||||
uv run djlint src/ --reformat --format-js --format-css # Format templates, JS and CSS, --check to just check
|
||||
uv run flake8 src/ # Python linter
|
||||
```
|
||||
|
||||
|
||||
### Testing
|
||||
|
||||
TODO
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue