project-tracking-record

A project to track all my projects

🚦 Status

Currrently is just JSON supported. In the future maybe also .yml or .md

👩 Author

Robert Willemelis

⚖️ License

Apache License 2.0

🚀 Getting Started

1. Create a PROJECT.json file in the root of your project.
2. Add the following minimal properties to the PROJECT.json file:

{
  "$schema": "./project.schema.json",
  "🗂️ name": "<NAME>",
  "📄 id": "ROB-001",
  "⚖️ license": "Apache License 2.0",
  "👩 author": "Robert Willemelis",
  "🚦 status": "active"
}

3. Optionally, you can add more properties to the PROJECT.json file as needed. For this check the project.schema.json file for all available properties and their descriptions.

4. Add the project.schema.json file to the root of your project or reference it from a remote URL.

   • local

     {
       "$schema": "./project.schema.json",
     }

   • remote:

     {
       "$schema": "https://willi84.github.io/project-tracking-record/project.schema.json",
     }

5. [optional] Make sure your remote schema is trusted by the editor. For VSCode:

• Go To Quick Fixes (Ctrl + .) > configure trusted domains > add https://willi84.github.io as trusted domain or uri
• the result schould look like:

6. Validate your PROJECT.json file against the schema to ensure it is correctly formatted and contains all required properties.

Changelog

See CHANGELOG.md for a detailed list of changes and updates

Credits

• publiccode.yml - for the inspiration of to track projects by using a standardized file format
• opencode.de - for using publiccode.yml as example for project tracking
• ruvnet - for the idea to use ADRs to track the architecture decisions of a project.
• Glen Maddern - for the idea of emoji usage ❤️