2021-02-26 08:44:40 +00:00
# Getting started
2014-09-11 15:01:22 +00:00
2021-02-26 09:00:08 +00:00
```eval_rst
.. note::
These instructions assume familiarity with virtual environments and the
`Django web framework <https://www.djangoproject.com/>` _.
For more detailed instructions, see :doc:`tutorial`.
To add Wagtail to an existing Django project, see :doc:`integrating_into_django`.
```
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
## Dependencies needed for installation
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00: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.org/en/latest/installation.html#external-libraries ).
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
## Quick install
2018-10-27 08:20:55 +00:00
2019-04-08 22:18:27 +00:00
Run the following in a virtual environment of your choice:
2018-10-27 08:20:55 +00:00
2021-02-26 09:01:23 +00:00
```sh
2021-02-26 08:44:40 +00:00
$ pip install wagtail
```
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
(Installing outside a virtual environment may require `sudo` .)
2016-11-28 01:30:44 +00:00
2021-02-26 08:44:40 +00:00
Once installed, Wagtail provides a command similar to Django\'s `django-admin startproject` to generate a new site/project:
2015-05-28 09:12:48 +00:00
2021-02-26 09:01:23 +00:00
```sh
2021-02-26 08:44:40 +00:00
$ wagtail start mysite
```
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
This will create a new folder `mysite` , based on a template containing everything you need to get started.
2019-04-09 13:55:30 +00:00
More information on that template is available in
2021-02-26 09:06:11 +00:00
[the project template reference ](/reference/project_template ).
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
Inside your `mysite` folder, run the setup steps necessary for any Django project:
2016-11-28 01:30:44 +00:00
2021-02-26 09:01:23 +00:00
```sh
2021-02-26 08:44:40 +00:00
$ pip install -r requirements.txt
$ ./manage.py migrate
$ ./manage.py createsuperuser
$ ./manage.py runserver
```
2015-05-28 09:12:48 +00:00
2021-02-26 08:44:40 +00:00
Your site is now accessible at `http://localhost:8000` , with the admin backend available at `http://localhost:8000/admin/` .
2015-05-28 09:12:48 +00:00
2019-04-09 13:55:30 +00:00
This will set you up with a new stand-alone Wagtail project.
2021-04-15 16:17:11 +00:00
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 09:12:48 +00: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:
2021-02-26 09:06:11 +00:00
> - [Elasticsearch](/advanced_topics/performance).
> - [Feature Detection](image_feature_detection).
2014-09-11 15:01:22 +00:00
2021-02-26 09:08:12 +00:00
```eval_rst
.. toctree::
:maxdepth: 1
tutorial
demo_site
integrating_into_django
the_zen_of_wagtail
```