Jan Dittberner
045a3cd23a
- COPYING contains the GPL 3.0 license text - README.md contains a short description of the project - poetry.lock is the bill of material generated by poetry lock - pyproject.toml describes the project for use with Poetry
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# CAcert Assurer Training System - CATS
|
|
|
|
This is a Django port of the original
|
|
[CATS](https://code.cacert.org/cacert/cats/). The goal of this port is to use
|
|
current best practices in software engineering and to reduce boilerplate by
|
|
using a properly maintained web framework.
|
|
|
|
## Development setup
|
|
|
|
The project uses [Poetry](https://python-poetry.org/docs/) for dependency
|
|
management. On a Debian 12 system you can use the following commands to install
|
|
poetry and required dependencies:
|
|
|
|
```shell
|
|
sudo apt update
|
|
sudo apt install -y build-essential pkg-config default-libmysqlclient-dev python3-dev pipx
|
|
pipx install poetry
|
|
pipx ensurepath
|
|
```
|
|
|
|
If `pipx ensurepath` recommends to open a new shell, do it.
|
|
|
|
```shell
|
|
git clone https://code.cacert.org/cacert/django-cats.git
|
|
cd django-cats
|
|
poetry install
|
|
```
|
|
|
|
## License
|
|
|
|
CATS
|
|
Copyright (C) CAcert
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|