Development Guide - larralapid/personal-backstage GitHub Wiki

Development Guide

๐Ÿ› ๏ธ Project Structure

self-catalog/
โ”œโ”€โ”€ packages/
โ”‚   โ”œโ”€โ”€ app/           # Frontend React application
โ”‚   โ””โ”€โ”€ backend/       # Backend Node.js services
โ”œโ”€โ”€ examples/          # Catalog configuration files
โ”‚   โ”œโ”€โ”€ personal-infrastructure.yaml
โ”‚   โ”œโ”€โ”€ data-templates.yaml
โ”‚   โ””โ”€โ”€ backlog-templates.yaml
โ”œโ”€โ”€ test-*.js          # Test suite files
โ””โ”€โ”€ docs/              # Documentation

Contributing to Your Setup

  1. Add New Projects: Edit examples/personal-infrastructure.yaml
  2. Create Templates: Add to examples/data-templates.yaml
  3. Update Config: Modify app-config.yaml
  4. Test Changes: Run node test-config.js

๐Ÿงช Testing

The project includes a comprehensive test suite:

# Run all tests
node run-all-tests.js

# Run specific test suites
node test-config.js           # Configuration validation
node test-catalog-simple.js   # Catalog relationships
node test-runtime.js         # Application startup

๐Ÿ“Š Current Status

Test Results Configuration Catalog

  • 80 Total Tests with 97.5% Pass Rate
  • 28 Configuration Tests - All passing
  • 48 Catalog Tests - All passing
  • Full Frontend - Working perfectly
  • Backend - Partial (native dependency issues)

๐Ÿค Contributing

This is a personal project, but contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Run the test suite
  4. Submit a pull request