Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Commit 9868983

Browse files
committed
Documented installation and configuration steps
1 parent 8d1bc02 commit 9868983

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,95 @@ wagtail-pythonanywhere-quickstart
1313

1414
Prerequisites
1515
-------------
16+
1617
* You have an account at `PythonAnywhere`_
1718

1819
.. _PythonAnywhere: https://www.pythonanywhere.com
1920

2021
Recommendations
2122
---------------
23+
2224
* You use `virtualenv`_ for isolated local python development
2325
* You are familiar with the `Django`_ basics, at least visited their great `online tutorial`_
2426

2527
.. _virtualenv: https://virtualenv.pypa.io
2628
.. _Django: https://www.djangoproject.com
2729
.. _online tutorial: https://docs.djangoproject.com/en/dev/intro/tutorial01
30+
31+
Technical requirements
32+
----------------------
33+
34+
Below is the list of currently supported combinations of Wagtail, Django and Python:
35+
36+
+---+---------+-----------+--------------------+
37+
| # | Wagtail | Django | Python |
38+
+===+=========+===========+====================+
39+
| 1 | 1.12 | 1.8, 1.10 | 2.7, 3.4, 3.5 |
40+
+---+---------+-----------+--------------------+
41+
| 2 | 1.12 | 1.11 | 2.7, 3.4, 3.5, 3.6 |
42+
+---+---------+-----------+--------------------+
43+
44+
Set up the python application
45+
-----------------------------
46+
47+
* Open a bash console on PythonAnywhere
48+
* Create a virtualenv
49+
50+
``mkvirtualenv wagtail-pythonanywhere-quickstart-py36 --python=/usr/bin/python3.6``
51+
52+
* Clone the repository
53+
54+
``git clone https://github.com/texperience/wagtail-pythonanywhere-quickstart.git``
55+
56+
* Change into the project directory
57+
58+
``cd wagtail-pythonanywhere-quickstart``
59+
60+
* Install the python packages
61+
62+
``pip install -r requirements.txt``
63+
64+
* Prepare a local configuration file
65+
66+
* Create a new file called ``local.py`` under ``wagtail-pythonanywhere-quickstart/settings``
67+
* Define at least the ``SECRET_KEY`` and ``ALLOWED_HOSTS`` settings
68+
* Typically you may want to define ``DATABASES`` and point ``MEDIA_ROOT`` as well as ``STATIC_ROOT`` to a persistent directory
69+
70+
* Initialize the database
71+
72+
``python manage.py migrate``
73+
74+
* Create a superuser account
75+
76+
``python manage.py createsuperuser``
77+
78+
* Collect static files
79+
80+
``python manage.py collectstatic``
81+
82+
Set up the web server
83+
---------------------
84+
85+
* Open the PythonAnywhere "Web" tab
86+
* Select ``Add a new web app``
87+
* Choose ``Manual configuration (including virtualenvs)``
88+
* Choose ``Python 3.6``
89+
90+
After your web app is created:
91+
92+
* Set the source code location to your projects home
93+
* Change the WSGI configuration file
94+
* Set the virtualenv path to the environment created above
95+
* Set static and media urls and location
96+
* Restart your application
97+
98+
Code and contribution
99+
---------------------
100+
101+
The code is open source and released under the `ISC License (ISCL)`_. It is available on `GitHub`_ and follows the guidelines about `Semantic Versioning`_ for transparency within the release cycle and backward compatibility whenever possible.
102+
103+
All contributions are welcome, whether bug reports, code contributions and reviews, documentation or feature requests.
104+
105+
.. _ISC License (ISCL): http://en.wikipedia.org/wiki/ISC_license
106+
.. _Semantic Versioning: http://semver.org/
107+
.. _GitHub: https://github.com/texperience/texsite

0 commit comments

Comments
 (0)