Skip to content

Commit

Permalink
📝 Document local deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
P3nny committed Oct 29, 2018
1 parent be5cc3f commit 0f39520
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# wdrforyou-cms
CMS for the WDRforyou bot

## Django on AWS using Zappa
Our CMS is based on [Django](https://www.djangoproject.com/) and hosted on AWS Lambda using [Zappa](https://zappa.io).
It provides a REST-API for [wdrforyou-bot](https://github.com/wdr-data/wdrforyou-bot).


## Local development
We don't advise to deploy to AWS for local development, as it is quite time consuming to set up. Test locally using:

Enable pipenv shell:
```
$ pipenv shell
```

To run local development server:
```
$ app/manage.py runserver
```
For database migrations use:

```
$ app/manage.py makemigrations
$ app/manage.py migrate
```

Alternatively you can run commands without enabling pipenv shell, for example:
```$ pipenv run app/manage.py runserver```

## Deployment
TBD

0 comments on commit 0f39520

Please sign in to comment.