Pegasus’s Code Structure¶
Overall structure¶
This is the overall structure of a new Pegasus project:
{{project_name}}/
├── {{project_name}}
├── apps
│ ├── subscriptions
│ ├── teams
│ ├── users
│ ├── utils
│ └── web
├── pegasus
│ ├── apps
├── assets
│ ├── javascript
│ └── styles
├── requirements
└── static
├── css
├── images
└── js
├── templates
The first three directories are Python modules while the remaining ones are not.
Your {{project_name}}
module¶
This is your Django project root directory.
It’s where your settings, root urlconf and wsgi.py
file will live.
Your apps
module¶
This is where your project’s apps will live. It is pre-populated with Pegasus’s default apps for you to further customize to your needs.
The module starts with up to five apps, depending on your configuration.
subscriptions
is for functionality related to Stripe subscriptions.users
is where your user models and views are defined.teams
is where team models and views are defined.utils
is a set of functionality shared across the project.web
contains utilities and components related to the generic views, layouts and templates.
The pegasus
module¶
This is where the Pegasus examples live.
In general it is not expected that you’ll need to modify much in this module, though feel free to do so!
The requirements
folder¶
This is where you define your project’s Python requrements.
Requirements are managed using pip-tools
.
For more information on using it see their documentation.
The assets
folder¶
This is where the source files for your site’s JavaScript and CSS live. These files are what you should edit to change your JS and CSS.
See front-end for more information on how to compile these files.
The static
folder¶
This folder contains your project’s static files, including the compiled output files
from the assets
folder as well as images.
The templates
folder¶
This folder contains your project’s Django templates.
There is one sub-folder for each application that has templates.
The majority of the project’s base template layouts are in the templates/web
folder.