Start a new Project
AqLib ❤️ project-template
AqLib and project-template work together to bootstrap your project.
project-template is your starting point for a new project.
AqLib is your component gallery to pick from.
Getting Started
- Create your repository from pdo-project-template:
click Use this template on GitHub, or run:
The template ships an optimal folder structure, a documentation sample, project JSON files, the latest polished PMD ruleset, and more.gh repo create my-project --template aquivalabs/pdo-project-template --private --clone
- Review the folder structure in
force-app:
- Your main project code goes under the
mainfolder. soql,mock,test, andtriggerare essential libraries that your project in themainfolder will reuse. Several open-source libraries come pre-packed.
- Use AqLib as a navigator to find additional components and open-source libraries that could be useful to your project and speed up your development.
Recommended folder structure
┌─ config - project scratch org definitions
├─ documentation - create technical documentation in this folder
│ └─ solution-design.md
├── force-app - code
│ ├─ AqLib - keep AqLib near your other open-source libraries
│ │ ├─ apex
│ │ │ ├─ component-1
│ │ │ └─ component-2
│ │ └─ modules
│ │ ├─ module-1
│ │ └─ module-2
│ ├─ main - project code
│ │ ├─ default - by default, shared, common, or core code can go to this folder
│ │ ├─ module-1 - different feature areas can be placed in other folders
│ │ └─ module-2
│ ├─ soql - essential open-source libraries already included.
│ ├─ trigger - if you don't need something, just delete it
│ ├─ mock
│ ├─ test
│ ├─ open-source-lib-1 - place other open-source dependencies in the same folder
│ └─ open-source-lib-2
└── scripts
❌ Never place project-template in a subfolder. It is not a library!
force-app
└─ lib
├─ AqLib
└─ project-template