ticketfrei/ticketfrei3
8
1
Fork 0
Code Issues 11 Pull requests 2 Projects 1 Releases Wiki Activity

[doc] Update pip wheel, setuptools, pip packages

Browse source
This commit is contained in:
Martin Rey 2020-09-22 17:13:25 +02:00
parent 07eaf4e573
commit e72816d4c4
Signed by untrusted user who does not match committer: mrey
GPG key ID: 4EAFAF039839B334
2 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -8,13 +8,14 @@
1. Install `python>=3.8`
2. Create a virtual environment with `python3 -m venv .venv`
3. Activate your dev environment with `source .venv/bin/activate`
4. Install with `pip install .`
5. Install development dependencies with `pip install tox black`
6. Add git-hook to run test and stylecheck before commmit with
4. Update pip packages with `pip install -U pip setuptools wheel`
5. Install with `pip install .`
6. Install development dependencies with `pip install tox black`
7. Add git-hook to run test and stylecheck before commmit with
`ln -s ../../git-hooks/pre-commit .git/hooks/pre-commit`
7. Add git-hook to check commmit message format with
8. Add git-hook to check commmit message format with
`ln -s ../../git-hooks/commit-msg .git/hooks/commit-msg`
8. Turn off production mode: `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'`
9. Turn off production mode: `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'`
#### Cheatsheet

2
DEPLOYMENT.md
View file

@ -19,7 +19,7 @@ export PATH="$PATH:$PIP_PACKAGES/bin"
### Build backend on the server
- Clone the repository: `git clone https://github.com/acipm/kibicara`
- Install backend: `cd kibicara && pip install --user .`
- Install backend: `cd kibicara && pip install -U --user pip setuptools wheel && pip install --user .`
### Build frontend on your local machine
Since Angular CLI is quite bloaty and your server may don't have enough resouces, we recommend to build the frontend locally and copying it onto the server. The same steps can be used on the server if it has enough resources.