0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs/getting_started/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

68 lines
2.2 KiB
Markdown
Raw Normal View History

```{eval-rst}
:hidetoc: 1
```
2021-02-26 09:44:40 +01:00
# Getting started
```{note}
2021-02-26 10:00:08 +01:00
These instructions assume familiarity with virtual environments and the
[Django web framework](https://www.djangoproject.com/).
For more detailed instructions, see [](tutorial).
To add Wagtail to an existing Django project, see [](integrating_into_django).
2021-02-26 10:00:08 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
## Dependencies needed for installation
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
- [Python 3](https://www.python.org/downloads/)
- **libjpeg** and **zlib**, libraries required for Django's **Pillow** library.
See Pillow's [platform-specific installation instructions](https://pillow.readthedocs.io/en/stable/installation.html#external-libraries).
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
## Quick install
Run the following commands in a virtual environment of your choice:
2021-02-26 10:01:23 +01:00
```sh
pip install wagtail
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
(Installing wagtail outside a virtual environment may require `sudo`. sudo is a program to run other programs with the security privileges of another user, by default the superuser)
Once installed, Wagtail provides a command similar to Django's `django-admin startproject` to generate a new site/project:
2015-05-28 11:12:48 +02:00
2021-02-26 10:01:23 +01:00
```sh
wagtail start mysite
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
This will create a new folder `mysite`, based on a template containing everything you need to get started.
More information on that template is available in
2021-02-26 10:06:11 +01:00
[the project template reference](/reference/project_template).
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
Inside your `mysite` folder, run the setup steps necessary for any Django project:
2021-02-26 10:01:23 +01:00
```sh
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
Your site is now accessible at `http://localhost:8000`, with the admin backend available at `http://localhost:8000/admin/`.
2015-05-28 11:12:48 +02:00
This will set you up with a new stand-alone Wagtail project.
If you'd like to add Wagtail to an existing Django project instead, see [Integrating Wagtail into a Django project](/getting_started/integrating_into_django).
2015-05-28 11:12:48 +02:00
There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including:
- [Elasticsearch](/advanced_topics/performance).
- [Feature Detection](image_feature_detection).
```{toctree}
---
maxdepth: 1
---
tutorial
demo_site
integrating_into_django
the_zen_of_wagtail
2021-02-26 10:08:12 +01:00
```