mirror of
https://github.com/krateng/maloja.git
synced 2023-08-10 21:12:55 +03:00
Finished basic dev instructions, close GH-57
This commit is contained in:
parent
c82936ad4a
commit
61b1271491
@ -1,19 +1,46 @@
|
|||||||
# Basic Development Instructions
|
# Development
|
||||||
|
|
||||||
After you've cloned the repository, traverse into the `maloja` folder with `cd maloja`.
|
Clone the repository and enter it.
|
||||||
|
|
||||||
|
```console
|
||||||
|
git clone https://github.com/krateng/maloja
|
||||||
|
cd maloja
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
To avoid cluttering your system, consider using a [virtual environment](https://docs.python.org/3/tutorial/venv.html).
|
||||||
|
|
||||||
Your system needs several packages installed. On Alpine, this can be done with
|
Your system needs several packages installed. On Alpine, this can be done with
|
||||||
|
|
||||||
`sh ./install/install_dependencies.sh`
|
```console
|
||||||
|
sh ./install/install_dependencies.sh
|
||||||
|
```
|
||||||
|
|
||||||
For other distros, try to find the equivalents of the packages listed or simply check your error output.
|
For other distros, try to find the equivalents of the packages listed or simply check your error output.
|
||||||
|
|
||||||
Then install all Python dependencies with `pip install -r requirements.txt`. To avoid cluttering your system, consider using a [virtual environment](https://docs.python.org/3/tutorial/venv.html).
|
Then install all Python dependencies with
|
||||||
|
|
||||||
|
```console
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Running the server
|
## Running the server
|
||||||
|
|
||||||
For development, you might not want to install maloja files all over your filesystem. Use the environment variable `MALOJA_DATA_DIRECTORY` to force all user files into one central directory - this way, you can also quickly change between multiple configurations.
|
For development, you might not want to install maloja files all over your filesystem. Use the environment variable `MALOJA_DATA_DIRECTORY` to force all user files into one central directory - this way, you can also quickly change between multiple configurations.
|
||||||
|
|
||||||
You can quickly run the server with all your local changes with `python3 -m maloja run`.
|
You can quickly run the server with all your local changes with
|
||||||
|
|
||||||
You can also build the package with `pip install .`.
|
```console
|
||||||
|
python3 -m maloja run
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also build the package with
|
||||||
|
|
||||||
|
```console
|
||||||
|
pip install .
|
||||||
|
```
|
||||||
|
## Further help
|
||||||
|
|
||||||
|
Feel free to [ask](https://github.com/krateng/maloja/discussions) if you need some help!
|
||||||
|
Loading…
Reference in New Issue
Block a user