Developer GuideΒΆ
These pages describe how C-PAT is built and how to change it. They are for people working on the API, the web client, the database, or this documentation. Deploying and operating C-PAT is covered in Setup and Deployment, using the application in User Guide, and administering it in Administrative Guide.
Learn by doing. Set up a development environment takes you from a clean machine to a running local instance with passing tests.
Get a task done. The how-to pages give the steps for the changes you make most often: Add an API endpoint, Add a client page, Add a database migration, and Add a configuration variable. Debugging and troubleshooting and Contributing are task pages too.
Look something up. API contract and reference, Coding standards, Testing, Release process, Dependencies and upgrades, and the Glossary.
Understand why. Architecture overview, the Backend guide and Frontend guide guides, and Database and migrations.
If you are new to the project, read Set up a development environment, then Architecture overview, then Contributing.
Contents:
- 1. Project and resources
- 2. Set up a development environment
- 3. Architecture overview
- 4. Backend guide
- 5. Frontend guide
- 6. Database and migrations
- 7. API contract and reference
- 8. Testing
- 9. Coding standards
- 10. Add an API endpoint
- 11. Add a client page
- 12. Add a database migration
- 13. Add a configuration variable
- 14. Debugging and troubleshooting
- 15. Contributing
- 16. Release process
- 17. Dependencies and upgrades
- 18. Documentation
- 19. Glossary