187 lines
4.0 KiB
Markdown
187 lines
4.0 KiB
Markdown
# Contribution Guide
|
|
|
|
|
|
Development of this project has been setup to be done from VSCodium. The following additional requirements need to be met:
|
|
|
|
- npm has been installed. _required for `markdown` linting_
|
|
|
|
`sudo apt install -y --no-install-recommends npm`
|
|
|
|
- setup of other requirements can be done with `make prepare`
|
|
|
|
- **ALL** Linting must pass for Merge to be conducted.
|
|
|
|
_`make lint`_
|
|
|
|
## TL;DR
|
|
|
|
|
|
from the root of the project to start a test server use:
|
|
|
|
``` bash
|
|
|
|
# activate python venv
|
|
source /tmp/centurion_erp/bin/activate
|
|
|
|
# enter app dir
|
|
cd app
|
|
|
|
# Start dev server can be viewed at http://127.0.0.1:8002
|
|
python manage.py runserver 8002
|
|
|
|
# Run any migrations, if required
|
|
python manage.py migrate
|
|
|
|
# Create a super suer if required
|
|
python manage.py createsuperuser
|
|
|
|
```
|
|
|
|
## Makefile
|
|
|
|
!!! tip "TL;DR"
|
|
Common make commands are `make prepare` then `make docs` and `make lint`
|
|
|
|
Included within the root of the repository is a makefile that can be used during development to check/run different items as is required during development. The following make targets are available:
|
|
|
|
- `prepare`
|
|
|
|
_prepare the repository. init's all git submodules and sets up a python virtual env and other make targets_
|
|
|
|
- `docs`
|
|
|
|
_builds the docs and places them within a directory called build, which can be viewed within a web browser_
|
|
|
|
- `lint`
|
|
|
|
_conducts all required linting_
|
|
|
|
- `docs-lint`
|
|
|
|
_lints the markdown documents within the docs directory for formatting errors that MKDocs may/will have an issue with._
|
|
|
|
- `clean`
|
|
|
|
_cleans up build artifacts and removes the python virtual environment_
|
|
|
|
|
|
> this doc is yet to receive a re-write
|
|
|
|
|
|
## Docker Container
|
|
|
|
within the `deploy/` directory there is a docker compose file. running `docker compose up` from this directory will launch a full stack deployment locally containing Centurion API, User Interface, a worker and a RabbitMQ server. once launched you can navigate to `http://127.0.0.1/` to start browsing the site.
|
|
|
|
You may need to run migrations if your not mounting your own DB. to do this run `docker exec -ti centurion-erp python manage.py migrate`
|
|
|
|
## Page speed tests
|
|
|
|
to run page speed tests (requires a working prometheus and grafa setup). use the following
|
|
|
|
|
|
``` bash
|
|
|
|
clear; \
|
|
K6_PROMETHEUS_RW_TREND_STATS="p(99),p(95),p(90),max,min" \
|
|
K6_PROMETHEUS_RW_SERVER_URL=http://<prometheus url>:9090/api/v1/write \
|
|
BASE_URL="http://127.0.0.1:8002" \
|
|
AUTH_TOKEN="< api token of superuser>" \
|
|
k6 run \
|
|
-o experimental-prometheus-rw \
|
|
--tag "commit=$(git rev-parse HEAD)" \
|
|
--tag "testid=<name of test for ref>" \
|
|
test/page_speed.js
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Tips / Handy info
|
|
|
|
- To obtain a list of models _(in in the same order as the file system)_ using the db shell `python3 manage.py dbshell` run the following sql command:
|
|
|
|
``` sql
|
|
|
|
SELECT model FROM django_content_type ORDER BY app_label ASC, model ASC;
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Old working docs
|
|
|
|
|
|
## Dev Environment
|
|
|
|
It's advised to setup a python virtual env for development. this can be done with the following commands.
|
|
|
|
``` bash
|
|
|
|
python3 -m venv venv
|
|
|
|
source venv/bin/activate
|
|
|
|
pip install -r requirements.txt
|
|
|
|
```
|
|
|
|
To setup the centurion erp test server run the following
|
|
|
|
``` bash
|
|
|
|
cd app
|
|
|
|
python manage.py runserver 8002
|
|
|
|
python3 manage.py migrate
|
|
|
|
python3 manage.py createsuperuser
|
|
|
|
# If model changes
|
|
python3 manage.py makemigrations --noinput
|
|
|
|
# To update code highlight run
|
|
pygmentize -S default -f html -a .codehilite > project-static/code.css
|
|
|
|
```
|
|
|
|
Updates to python modules will need to be captured with SCM. This can be done by running `pip freeze > requirements.txt` from the running virtual environment.
|
|
|
|
|
|
|
|
## Tests
|
|
|
|
!!! danger "Requirement"
|
|
All models **are** to have tests written for them, Including testing between dependent models.
|
|
|
|
See [Documentation](https://nofusscomputing.com/projects/django-template/development/testing/) for further information
|
|
|
|
|
|
## Docker Container
|
|
|
|
``` bash
|
|
|
|
cd app
|
|
|
|
docker build . --tag centurion-erp:dev
|
|
|
|
docker run -d --rm -v ${PWD}/db.sqlite3:/app/db.sqlite3 -p 8002:8000 --name app centurion-erp:dev
|
|
|
|
```
|
|
|