Skip to content

django-cms/django-cms.org

Repository files navigation

django-cms.org

This repository contains the source code for the official django-cms.org website.

Overview

The site is built using the django-cms-quickstarter project as its foundation, providing a modern and maintainable setup for running the django CMS-powered website.

Features

Getting Started

Prerequisites

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

Local Development Setup

  1. Clone this repository:
git clone https://github.com/django-cms/django-cms.org.git
cd django-cms.org
  1. Build and start the project using Docker Compose:
docker compose build web
docker compose up -d database_default
docker compose run web python manage.py migrate
docker compose run web python manage.py createsuperuser
docker compose up -d
  1. Open your browser and navigate to:

    http://django-cms.org.127.0.0.1.nip.io:8000 (or just http://127.0.0.1:8000)

Contributing

Contributions are welcome! Please open issues or pull requests for improvements or bug fixes.

License

This project is licensed under the terms of the MIT License.

Frontend Development

This project uses Bootstrap SCSS and Gulp for frontend asset compilation. For detailed information about the frontend development workflow, including:

  • SCSS architecture and file structure
  • Bootstrap customization
  • Gulp task configuration
  • Development and production builds
  • File watching

Please refer to the comprehensive guide:

📖 [Frontend Development Guide](docs/frontend_development_guide.rst)

Quick Start

Install dependencies and start development:

npm install
npm run dev

Build for production:

npm run build

About

django-cms.org

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 5