Skip to content
/ django-template Public template
forked from tuwien-club/ccms

A futuristic CI/CD based implementation of the Wagtail CMS emphasising on reliability. It is aimed to improve the maintainability of tuwien.club.

License

Notifications You must be signed in to change notification settings

zilkf92/django-template

 
 

Repository files navigation

tuwien-club logo

tuwien-club - Compact Content Management System

This is the official CCMS projects of tuwien-club.

Report bug · Request feature · Documentation

Table of contents

Quick start

Several quick start options are available:

Setup with Docker

Dependencies

Installation

Run the following commands:

git clone https://github.com/tuwien-club/ccms.git
cd Wagtail-Template
docker-compose up --build -d
docker-compose up

The demo site will now be accessible at http://localhost:8000/.

Important: This docker-compose.yml is configured for local testing only, and is not intended for production use.

Debugging

To tail the logs from the Docker containers in realtime, run:

docker-compose logs -f

Setup with Python Virtual Environment

You can start a Wagtail project from this template without setting up Docker and simply use a virtual environment, which is the recommended installation approach for all Python projects itself.

Dependencies

  • Python 3.5, 3.6 or 3.7

Installation

With PIP installed, run:

git clone https://github.com/tuwien-club/ccms.git
cd Wagtail-Template
python --version
python -m pip --version

Confirm that this is showing a compatible version of Python 3.x. If not, and you have multiple versions of Python installed on your system, you may need to specify the appropriate version when creating the venv:

python3 -m venv /path/to/new/virtual/environment

Once a virtual environment has been created, it can be “activated” using a script in the virtual environment’s binary directory. The invocation of the script is platform-specific ( must be replaced by the path of the directory containing the virtual environment):

Platform Shell Command to activate virtual environment
Posix bash/zsh $ source /bin/activate
fish $ . /bin/activate.fish
csh/tcsh $ source /bin/activate.csh
Windows cmd.exe C:> \Scripts\activate.bat
PowerShell PS C:> \Scripts\Activate.ps1

Now we're ready to set up the project itself:

pip install -r requirements/base.txt

To set up your database and load initial data, run the following commands:

./manage.py migrate
./manage.py runserver

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

GitHub last commit GitHub issues GitHub closed issues

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All code should conform to the Code Guide, maintained by tuwien-club.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this repository is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Creators

Avatar kleberbaum
Florian Kleber

Thanks

We do not have any external contributors yet, but if you want your name to be here, feel free to contribute to our project.

Copyright and license

GitHub repository license

SPDX-License-Identifier: (EUPL-1.2) Copyright © 2021 tuwien-club

About

A futuristic CI/CD based implementation of the Wagtail CMS emphasising on reliability. It is aimed to improve the maintainability of tuwien.club.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 44.0%
  • JavaScript 32.4%
  • HTML 14.3%
  • CSS 5.7%
  • Roff 2.4%
  • Dockerfile 0.9%
  • Shell 0.3%