🏗️ SelfCoE - Self-Service Center of Excellence

A comprehensive Self-Service Center of Excellence built on Backstage. Empowering developers with unified service catalog, scaffolding templates, and organizational standards for modern software development.

✨ Features

• 🏗️ Service Catalog - Centralized view of all services, APIs, and components
• 🚀 Software Templates - Scaffolding tools for consistent project creation
• 📊 Developer Analytics - Usage metrics and insights
• 🔐 Authentication & Authorization - Secure access control
• 📚 Documentation Hub - Unified technical documentation
• 🔍 Search & Discovery - Find resources across your organization

🚀 Quick Start

Prerequisites

• Node.js 20.x or 22.x
• Yarn 4.4.1
• Git

Installation

# Clone the repository
git clone https://github.com/larralapid/SelfCoE.git
cd SelfCoE

# Install dependencies
yarn install

# Start the development server
yarn start

The application will be available at:

• Frontend: http://localhost:3000
• Backend API: http://localhost:7007

📖 Documentation

Visit our documentation site for:

• Getting Started Guide
• Changelog
• Contributing Guidelines
• API Reference

🛠️ Development

Available Scripts

# Start development server
yarn start

# Build for production
yarn build:all

# Run tests
yarn test

# Run linting
yarn lint

# Type checking
yarn tsc

Project Structure

SelfCoE/
├── packages/
│   ├── app/           # Frontend React application
│   └── backend/       # Backend Node.js API
├── plugins/           # Custom Backstage plugins
├── docs/             # Documentation and GitHub Pages
├── examples/         # Example entities and templates
└── app-config.yaml   # Backstage configuration

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details on:

• Code of Conduct
• Development process
• Submitting pull requests
• Reporting issues

📊 Project Status

Current development focus:

• Initial Backstage setup and configuration
• Basic service catalog and scaffolding
• Authentication provider configuration
• Production database setup
• Custom plugins and integrations
• Deployment pipeline

See our GitHub Issues for detailed roadmap and progress.

🔧 Configuration

Environment Variables

# Development
NODE_ENV=development
POSTGRES_HOST=localhost
POSTGRES_PORT=5432

# Production
NODE_ENV=production
POSTGRES_HOST=your-db-host
POSTGRES_PORT=5432

Key Configuration Files

• app-config.yaml - Main Backstage configuration
• app-config.local.yaml - Local development overrides
• app-config.production.yaml - Production settings

🚀 Deployment

Docker

# Build backend image
yarn build-image

# Run with Docker Compose
docker-compose up -d

Kubernetes

# Apply manifests
kubectl apply -f k8s/

📝 License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Note: This project is open source under the Apache License 2.0.

🙏 Acknowledgments

Built with:

• Backstage - The platform for building developer portals
• React - Frontend framework
• Node.js - Backend runtime
• TypeScript - Type safety

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: Project Docs

---

Made with ❤️ for the developer community