This page covers the structure of the CS Field Guide project. The following diagram will be helpful when reading the following sections:
│ ├── appendices/
│ ├── build/
│ ├── chapters/
│ ├── config/
│ ├── curriculum_guides/
│ ├── general/
│ ├── interactives/
│ ├── locale/
│ ├── search/
│ ├── static/
│ ├── staticfiles/
│ ├── templates/
│ ├── tests/
│ ├── third-party-licences/
│ ├── utils/
│ ├── gulpfile.js
│ ├── make-interactive-thumbnails.js
│ ├── manage.py
│ └── package.json
The repository directory (or root directory) contains the following:
This directory contains the Django web system for the CS Field Guide website. This includes all raw text content, images, resources, etc.
This directory contains the documentation for the repository (which includes the file you are reading now).
This directory contains subtitle files for CS Field Guide videos.
This file contains an introduction and important information for the repository.
This file details the licences the repository uses.
Plus other files used for installation and repository configuration.
csfieldguide/ directory holds the Django web system and is split across
the following directories:
This directory holds the settings used by the Django system. It’s unlikely you’ll edit the contents of this directory unless you are changing the Django configuration (for example: adding a new application).
This directory holds all the tests for the project.
Utility functions used throughout the application. One example would be custom converter templates for Verto.
Django contains ‘applications’ which are Python packages that provide some set of features. Each large part/chunk of the CS Unplugged is a separate application. The project currently contains the following applications:
This application displays webpages for generic pages on the website. For example: homepage, about page, contact page, etc.
The core CS Field Guide content is split across chapters, with each topic containing any number of sections. THis applications stores and displays the chapters content.
This application displays a collection of curriculum guides to help teachers use CS Field Guide to help teach their own curriculum.
This application contains all of the interactive content used throughout CS Field Guide.
This application contains all the logic and ui to manage searching the entire website.
See the Adding a Chapter quick start for an example of dealing with an application.
The following directories are also required by the Django system:
This is where static files are served to the different applications inside the project.
This directory contains all the HTML templates for the Django system.
This directory contains translations required for the Django system. Translations for
topics/are stored within the
The following directories are used when the server is running (for example:
a script compiles the SCSS to CSS and saves it to the
build/ directory for
serving on a webpage).
You should never save anything in these directories, as the contents are often
overwritten and cleared.
Contains temporary files used in creating generated files for
csfieldguide/ directory also contains the following files:
A file created by Django used to manage the Django web system. Don’t modify the contents of this file.