https://github.com/ButterCMS/django-starter-buttercms
Drop-in proof-of-concept Python/Django app, fully integrated with your ButterCMS account
https://github.com/ButterCMS/django-starter-buttercms
butter buttercms cms django python starter-project
Last synced: 7 months ago
JSON representation
Drop-in proof-of-concept Python/Django app, fully integrated with your ButterCMS account
- Host: GitHub
- URL: https://github.com/ButterCMS/django-starter-buttercms
- Owner: ButterCMS
- Created: 2021-10-22T12:20:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T15:41:58.000Z (almost 2 years ago)
- Last Synced: 2025-02-10T11:46:25.650Z (over 1 year ago)
- Topics: butter, buttercms, cms, django, python, starter-project
- Language: Python
- Homepage: https://django-starter-buttercms-demo.herokuapp.com/
- Size: 649 KB
- Stars: 8
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- stars - ButterCMS/django-starter-buttercms - Drop-in proof-of-concept Python/Django app, fully integrated with your ButterCMS account (Python)
README
# Django + ButterCMS Starter Project
> [!IMPORTANT]
> We officially support Python versions 3.8 to 3.11. This project uses Python 3.11.8 and Django 4.2.20 LTS.
Live demo: [https://django-starter-buttercms-demo.herokuapp.com/](https://django-starter-buttercms-demo.herokuapp.com/)
This Django starter project fully integrates with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, and all with a beautiful, custom theme with already-implemented search functionality. All of the included sample content is automatically created in your account dashboard when you
[sign up for a free trial](https://buttercms.com/join/) of ButterCMS.
[](https://github.com/pydanny/cookiecutter-django/)
[](https://heroku.com/deploy?template=https://github.com/ButterCMS/django-starter-buttercms/&env[BUTTERCMS_API_TOKEN]=check%20https://buttercms.com/settings)
## 1) Installation
Clone the project and change into the new directory by running the following commands.
```bash
$ git clone https://github.com/ButterCMS/django-starter-buttercms.git
$ cd django-starter-buttercms
```
Follow the next steps depending on to your system.
### Linux and MacOS
Create a virtual environment and install dependencies by running the
below commands.
```bash
$ python3 -m venv butterenv && source butterenv/bin/activate
$ pip install --upgrade pip && pip install -r requirements.txt
```
### Windows
Create a virtual environment
```bash
$ python -m venv butterenv
```
Choose command to install dependencies:
In PowerShell:
```
$ .\butterenv\Scripts\Activate.ps1
```
In Command Prompt:
```
$ butterenv\Scripts\activate.bat
```
### 2) Set ButterCMS API Token
To fetch your ButterCMS content, add your API token as an environment variable.
```bash
$ echo 'BUTTERCMS_API_TOKEN=your_token' >> .env
```
### 3) Run Django Local Development Server
To view the app in the browser, you'll need to run the local development server:
```bash
$ python manage.py runserver
```
Congratulations! Your starter project is now live at: [http://localhost:8000/](http://localhost:8000/)
### 4) Deploy on Heroku
Our starter app can be deployed to Heroku with the click of a button:
1. Create a Heroku account at https://signup.heroku.com.
2. Click the button below and fill in an app name and your Butter API token. Then click "deploy".
[](https://heroku.com/deploy?template=https://github.com/ButterCMS/django-starter-buttercms/&env[BUTTERCMS_API_TOKEN]=check%20https://buttercms.com/settings)
### 5.) Previewing and Draft Changes
Your starter app allows you to preview draft changes made to content in your
ButterCMS.com account by default; to see draft changes, add '?preview=1' to the end of any
URL (e.g., http://localhost:8000/?preview=1)