Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update tutorial #124

Merged
merged 1 commit into from
Oct 21, 2021
Merged

Update tutorial #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 18 additions & 26 deletions docs/getting_started/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ $ source livesite/livesite/bin/activate

For other shells see the [`venv` documentation](https://docs.python.org/3/library/venv.html).



### Install Wagtail Live and other dependencies

Use pip to install Wagtail and Wagtail Live:
Expand Down Expand Up @@ -91,22 +89,18 @@ For now, add this to your `live_blog_page.html` template:
```
That's all we need in our models.

### Create the database

Let's create our tables now:

```console
$ python3 manage.py makemigrations
$ python3 manage.py migrate
```
## Configuring a publisher

### Create an admin user
The goal of publishers is to "publish" new updates to the frontend/client side.

```console
$ python3 manage.py createsuperuser
```
Choose and configure a publisher from the following list:

When logged into the admin site, a superuser has full permissions and is able to view/create/manage the database.
- Long Polling: [Set up long polling publisher](publishers/setup_long_polling.md)
- Interval Polling: [Set up interval polling publisher](publishers/setup_interval_polling.md)
- Django channels: [Set up Django channels publisher](publishers/setup_django_channels.md)
- PieSocket: [Set up PieSocket publisher](publishers/setup_piesocket.md)
- Websockets: [Set up websockets publisher](publishers/setup_websockets.md)
- Starlette: [Set up starlette publisher](publishers/setup_starlette.md)

## Configure an input source and its corresponding receiver

Expand All @@ -121,22 +115,20 @@ Choose an input source from the following list and configure its corresponding r
- Slack: [Setup Slack Events API receiver](receivers/setup_slack.md)
- Telegram: [Setup Telegram webhook receiver](receivers/setup_telegram.md)

## Configuring a publisher

The last step required is to configure a publisher.
That's it for the configuration part.

The goal of publishers is to "publish" new updates to the frontend/client side.
## Create the database

Choose and configure a publisher from the following list:
Finally, let's create our tables and an admin user:

- Long Polling: [Set up long polling publisher](publishers/setup_long_polling.md)
- Interval Polling: [Set up interval polling publisher](publishers/setup_interval_polling.md)
- Django channels: [Set up Django channels publisher](publishers/setup_django_channels.md)
- PieSocket: [Set up PieSocket publisher](publishers/setup_piesocket.md)
- Websockets: [Set up websockets publisher](publishers/setup_websockets.md)
- Starlette: [Set up starlette publisher](publishers/setup_starlette.md)
```console
$ python3 manage.py makemigrations
$ python3 manage.py migrate
$ python3 manage.py createsuperuser
```

That's it for the configuration part.
When logged into the admin site, a superuser has full permissions and is able to view/create/manage the database.

## Liveblogging

Expand Down