Skip to content

feat: update readme to make the wording a bit generic #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 5, 2021
Merged

feat: update readme to make the wording a bit generic #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2f2f64
feat: update readme to make the wording a bit generic
vinitkumar Feb 5, 2021
1c8397a
feat: fix typo on link
vinitkumar Feb 5, 2021
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# django CMS Divio quickstart
# django CMS quickstart

A Dockerised django CMS project, ready to deploy on Divio or another Docker-based cloud platform, and run
locally in Docker on your own machine. A Divio account is not required.
A Dockerised django CMS project, ready to deploy on [Divio](https://www.divio.com/) or another Docker-based cloud platform, and run locally in Docker on your own machine.

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

## Installation

You need to have docker installed on your system to run this project.

- [Install Docker](https://docs.docker.com/engine/install/) here.
- If you have not used docker in the past, please read this [introduction on docker](https://docs.docker.com/get-started/) here.

## Try it

```bash
git clone git@github.com:divio/django-cms-divio-quickstart.git
cd django-cms-divio-quickstart
git clone git@github.com:django-cms/django-cms-quickstart.git
cd django-cms-quickstart
docker-compose build
docker-compose run web python manage.py migrate
docker-compose run web python manage.py createsuperuser
Expand All @@ -33,5 +38,8 @@ see sections that can be removed - in each case, the section is noted with a com

Options are also available for using Postgres/MySQL, uWSGI/Gunicorn/Guvicorn, etc.

Again, see [Deploy a new django CMS project using the Divio quickstart
repository](https://docs.divio.com/en/latest/how-to/django-cms-deploy-quickstart/) for more guidance on customisation.
## Contribution

This code for this project has been forked from Divio's quickstart repo. We are grateful for their valueable contribution to the code and documentation of this code.

You can follow the original repo [here](https://github.com/divio/django-cms-divio-quickstart/).