Skip to content

Commit 575ebae

Browse files
committed
Updated README
1 parent 2a50a8d commit 575ebae

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,33 @@ locally in Docker on your own machine. A Divio account is not required.
55

66
This version uses Python 3.8 running and the most up-to-date versions of Django 3.1 and django CMS 3.8.
77

8-
For a complete how-to guide for this project, see [Deploy a new django CMS project using the Divio quickstart
8+
9+
## Try it
10+
11+
```bash
12+
git clone git@github.com:divio/django-cms-divio-quickstart.git
13+
cd django-cms-divio-quickstart
14+
docker-compose build
15+
docker-compose run web python manage.py migrate
16+
docker-compose run web python manage.py createsuperuser
17+
docker-compose up
18+
open http://127.0.0.1:8000
19+
```
20+
21+
For a more complete how-to guide to this project, see [Deploy a new django CMS project using the Divio quickstart
922
repository](https://docs.divio.com/en/latest/how-to/django-cms-deploy-quickstart/) in the [Divio Developer
1023
Handbook](https://docs.divio.com).
1124

12-
The guide shows you how to use this repository to deploy a Twelve-factor Django project including Postgres or MySQL,
13-
and cloud media storage using S3, with Docker. It also gives you a fully working local project for development,
14-
also running in Docker.
1525

16-
## Important
26+
## Customising the project
27+
28+
This project is ready-to-go without making any changes at all, but also gives you some options.
29+
30+
As-is, it will include a number of useful django CMS plugins and Bootstrap 4 for the frontend. You don't have to use
31+
these; they're optional. If you don't want to use them, read through the `settings.py` and `requirements.txt` files to
32+
see sections that can be removed - in each case, the section is noted with a comment containing the word 'optional'.
33+
34+
Options are also available for using Postgres/MySQL, uWSGI/Gunicorn/Guvicorn, etc.
1735

18-
This project is ready-to-go, but also gives you some options. As-is, it will include a number of useful django CMS
19-
plugins and Bootstrap 4 for the frontend. You don't have to use these; they're optional. If you don't want to use them,
20-
read through the `settings.py` and `requirements.txt` files to see sections that can be removed - in each case, the
21-
section is noted with a comment containing the word 'optional'.
36+
Again, see [Deploy a new django CMS project using the Divio quickstart
37+
repository](https://docs.divio.com/en/latest/how-to/django-cms-deploy-quickstart/) for more guidance on customisation.

0 commit comments

Comments
 (0)