Integreat Compass CMS documentation

This is the developer documentation for the Integreat Compass project.

Note

For general help with the Django framework, please refer to the Django documentation.

First Steps

• Installation: Installation guide

• Development Server: Run local development server

• Development Tools: Introduction to development tools

Basic Concepts

• Internationalization (i18n): Internationalization (i18n)

• Documentation (Sphinx): Documentation (Sphinx)

• Continuous Integration (CircleCI): Continuous Integration (Circle CI)

Deployment

• Packaging: Create an easily installable python package

• Production Server: Setup the production server

• Changelog: The release history including all relevant changes

Contributing

• Issue Reporting Guidelines: How to report issues four our project

• Code Style Guidelines: Guidelines on how to style your code

• GitHub Workflow: Description of our Git workflow

• Code of Conduct: Our code of conduct

Reference

• Integreat Compass: The main of the integreat-compass with the following sub-packages:

  • CMS: This is the content management system for backend users which contains all database models, views, forms and templates.

  • Core: This is the project’s main app which contains all configuration files.

Indices and tables

• Index

• Module Index

• Search Page