Add devel environment setup instructions
This commit is contained in:
parent
1245c191c0
commit
b512d42058
1 changed files with 48 additions and 2 deletions
50
README.md
50
README.md
|
@ -1,3 +1,49 @@
|
||||||
# ucloud
|
# Uncloud
|
||||||
|
|
||||||
Checkout https://ungleich.ch/ucloud/ for the documentation of ucloud.
|
Cloud management platform, the ungleich way.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
Install system dependencies:
|
||||||
|
* On Fedora, you will need the following packages: `python3-virtualenv python3-devel libpq-devel openldap-devel gcc chromium`
|
||||||
|
|
||||||
|
You will need a Postgres database running locally:
|
||||||
|
* Install on configure PGSQL on your base system.
|
||||||
|
* OR use a container! `podman run --rm -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust -it postgres:latest`
|
||||||
|
|
||||||
|
NOTE: you will need to configure a LDAP server and credentials for authentication. See `uncloud/settings.py`.
|
||||||
|
|
||||||
|
```
|
||||||
|
# Initialize virtualenv.
|
||||||
|
» virtualenv .venv
|
||||||
|
Using base prefix '/usr'
|
||||||
|
New python executable in /home/fnux/Workspace/ungleich/uncloud/uncloud/.venv/bin/python3
|
||||||
|
Also creating executable in /home/fnux/Workspace/ungleich/uncloud/uncloud/.venv/bin/python
|
||||||
|
Installing setuptools, pip, wheel...
|
||||||
|
done.
|
||||||
|
|
||||||
|
# Enter virtualenv.
|
||||||
|
» source .venv/bin/activate
|
||||||
|
|
||||||
|
# Install dependencies.
|
||||||
|
» pip install -r requirements.txt
|
||||||
|
[...]
|
||||||
|
|
||||||
|
# Run migrations.
|
||||||
|
» ./manage.py migrate
|
||||||
|
Operations to perform:
|
||||||
|
Apply all migrations: admin, auth, contenttypes, opennebula, sessions, uncloud_auth, uncloud_net, uncloud_pay, uncloud_service, uncloud_vm
|
||||||
|
Running migrations:
|
||||||
|
[...]
|
||||||
|
|
||||||
|
# Run webserver.
|
||||||
|
» ./manage.py runserver
|
||||||
|
Watching for file changes with StatReloader
|
||||||
|
Performing system checks...
|
||||||
|
|
||||||
|
System check identified no issues (0 silenced).
|
||||||
|
May 07, 2020 - 10:17:08
|
||||||
|
Django version 3.0.6, using settings 'uncloud.settings'
|
||||||
|
Starting development server at http://127.0.0.1:8000/
|
||||||
|
Quit the server with CONTROL-C.
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue