0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs/getting_started/index.md

65 lines
2.1 KiB
Markdown
Raw Normal View History

2021-02-26 09:44:40 +01:00
# Getting started
2021-02-26 10:00:08 +01: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 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.org/en/latest/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 in a virtual environment of your choice:
2021-02-26 10:01:23 +01:00
```sh
2021-02-26 09:44:40 +01:00
$ pip install wagtail
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
(Installing outside a virtual environment may require `sudo`.)
2021-02-26 09:44:40 +01:00
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
2021-02-26 09:44:40 +01:00
$ wagtail start mysite
```
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
2021-02-26 09:44:40 +01:00
$ pip install -r requirements.txt
$ ./manage.py migrate
$ ./manage.py createsuperuser
$ ./manage.py runserver
```
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.
2021-02-26 10:06:11 +01:00
If you\'d like to add Wagtail to an existing Django project instead, see [Integrating Wagtail into a Django project](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:
2021-02-26 10:06:11 +01:00
> - [Elasticsearch](/advanced_topics/performance).
> - [Feature Detection](image_feature_detection).
2021-02-26 10:08:12 +01:00
```eval_rst
.. toctree::
:maxdepth: 1
tutorial
demo_site
integrating_into_django
the_zen_of_wagtail
```