develop-custom-project.md

Develop a Custom Project

You can do these actions	via this resource	(status)
customize templates, static assets, settings, custom apps, URLs, middleware	Core-CMS-Custom	active
customize templates, static assets, settings	Core-CMS-Resources	deprecated
create custom apps	Django-App	active
create forked apps e.g. TACC/djangocms-forms	"Fork a repo"	evergreen

via Core CMS Custom

Work on the project only via Core CMS Custom.

Note You should not need to clone nor edit this Core CMS repository.

via Core CMS Resources

Update Project

To update /taccsite_custom to have pinned content from Core CMS Resources:

1. git submodule update

To update /taccsite_custom to have new content from Core CMS Resources:

1. cd taccsite_custom
2. Checkout desired Core CMS Resources branch.
3. git pull
4. cd ../

To make CMS on local machine register changes to files in /taccsite_custom:

types of files changed	action to take
static/css	build css
static/	collect static files
templates/	restart server

Build CSS

To compile CSS static files:

• from source files in src directories
• to compiled files in build directories

npm run build:css --project="custom_project_dir"
docker exec -it core_cms sh -c "python manage.py collectstatic --no-input"

This process allows use of future-proof CSS via Core Styles.

Commit Changes

To commit changes to a custom project:

1. cd taccsite_custom
2. Checkout or create a Core CMS Resources branch.
3. Commit changes.
4. cd ../
5. Add /taccsite_custom change.
6. Commit changes to a Core CMS branch.

Note For a more thorough walkthrough, read How to Change Submodule Branch Commit.