diff options
| -rw-r--r-- | azure-pipelines.yml | 4 | ||||
| -rw-r--r-- | docs/setup.md | 28 |
2 files changed, 28 insertions, 4 deletions
diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 78bbffae..35fb9f82 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -8,8 +8,10 @@ jobs: steps: - script: | + set -eux + curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - - sudo add-apt-repository deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable + sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" sudo apt-get update sudo apt-get install docker-ce displayName: install docker diff --git a/docs/setup.md b/docs/setup.md index d6e5a7bf..18f5ee97 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -26,6 +26,8 @@ in your environment variables: export DATABASE_URL=postgres://pysite@localhost/pysite ``` +After this step, inside the `.env` file, set the `SECRET_KEY` variable which can be anything you like. + A simpler approach to automatically configuring this might come in the near future - if you have any suggestions, please let us know! @@ -66,6 +68,26 @@ pip install -e .[lint,test] to install base dependencies along with lint and test dependencies. -You can either use `python manage.py` directly, or you can use the console -entrypoint for it, `psmgr`. For example, to run tests, you could use either -`python manage.py test` or `psmgr test`. Happy hacking! +To run tests, use `python manage.py test`. + +## Hosts file + +Make sure you add the following to your hosts file: + +```sh +127.0.0.1 pythondiscord.local +127.0.0.1 api.pythondiscord.local +127.0.0.1 staff.pythondiscord.local +127.0.0.1 admin.pythondiscord.local +127.0.0.1 wiki.pythondiscord.local +127.0.0.1 ws.pythondiscord.local +``` +When trying to access the site, you'll be using the domains above instead of the usual `localhost:8000`. + +Finally, you will need to set the environment variable `DEBUG=1`. When using `pipenv`, you can +set put this into an `.env` file to have it exported automatically. It's also recommended to +export `LOG_LEVEL=INFO` when using `DEBUG=1` if you don't want super verbose logs. + +To run the server, run `python manage.py runserver`. If it gives you an error saying +`django.core.exceptions.ImproperlyConfigured: Set the DATABASE_URL environment variable` please make sure the server that your postgres database is located at is running +and run the command `$(export cat .env)`. Happy hacking! |