Project Development Skill
This skill teaches you how to interact with the Supernote codebase using standardized scripts, following the "Scripts to Rule Them All" pattern.
Core Scripts
| Script | When to use |
|---|---|
script/bootstrap |
After cloning or when dependencies change. |
script/test |
Before submitting changes or to verify functionality. |
script/lint |
Before committing to ensure code style and quality. |
script/server |
When you need a running server for integration testing or manual verification. |
script/db_revision |
To generate a database migration revision. |
Usage Patterns
Standard Development Flow
- Initialize:
./script/bootstrap - Implement: Make your changes to the code.
- Database: If you changed models, run
./script/db_revision "...". - Lint:
./script/lintto check for style issues. - Test:
./script/testto run the test suite. - Verify:
./script/serverto run an ephemeral server for manual checks.
Notes
- All scripts are located in the
script/directory at the project root. - Scripts are designed to be run from the project root.
- The scripts will automatically use
uvif it is installed, otherwise they will fall back to standard Python tools.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.