mirror
/
maloja
mirror of https://github.com/krateng/maloja.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added initial basic dev instructions, GH-57

This commit is contained in:
krateng 2021-12-21 20:11:51 +01:00
parent ed309dd36e
commit 5ba455dc92
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
DEVELOPMENT.md Normal file
View File

@ -0,0 +1,13 @@
# Basic Development Instructions
After you've cloned the repository, traverse into the `maloja` folder with `cd maloja`.
Make sure all dependencies are installed.
Your system needs a few packages, on Alpine Linux these should all be installed with `sh install_alpine.sh`.
Python dependencies can be installed with `pip install -r requirements.txt`
## Running the server
You can quickly run the server with all your local changes with `python3 -m maloja.proccontrol.control run`.
You can also build the package with `pip install .`.