Skip to content

Stewie-pixel/mirabile



Mirabile CLI

Mirabile

Transform your dream career into a structured roadmap with intelligent, personalized resources.
Explore the docs Β»

πŸŽ₯ View Demo Β· Report Bug Β· Request Feature

πŸ“– About The Project

Mirabile is an intelligent career roadmap platform that converts user-defined career goals into structured learning paths with context-aware resources.

Users can input goals such as:

  • β€œSoftware Engineer at Google”
  • β€œAI Engineer focusing on machine learning”

Mirabile will:

  • Generate a multi-phase roadmap
  • Adapt based on role, domain, and company
  • Recommend targeted resources
  • Enable progress tracking and note-taking

πŸŽ₯ Demo

πŸ“Œ Replace the link below with your actual demo video (YouTube / Drive)

πŸ”— Demo Video: https://your-demo-link.com

What the demo should showcase:

  • Pipeline execution (Jenkins stages)
  • Roadmap generation
  • Resource recommendations
  • Deployment to staging/production
  • Monitoring/logging output

πŸ—οΈ Architecture

Frontend (React)
        ↓
Backend API (Node.js / Express)
        ↓
Business Logic Layer
- Input Parser
- Roadmap Generator
- Company Intelligence Engine
- Resource Recommender
        ↓
Database (MongoDB / PostgreSQL)

πŸ› οΈ Built With

  • React (Frontend)
  • Node.js / Express (Backend)
  • MongoDB / PostgreSQL (Database)
  • Docker (Containerization)
  • Jenkins (CI/CD Pipeline)
  • SonarQube (Code Quality)
  • Snyk / npm audit (Security Scanning)
  • Prometheus / Grafana (Monitoring)

πŸš€ Getting Started

Prerequisites

  • Node.js (v18+)
  • npm
  • Docker (optional)
npm install npm@latest -g

Installation

git clone https://github.com/Stewie-pixel/mirabile.git
cd mirabile
npm install

Create a .env file:

PORT=5000
DB_URI=your_database_connection

Run the app:

npm run dev

πŸ’‘ Usage

  1. Enter a career goal
  2. System processes input
  3. Generates roadmap + resources
  4. Track progress and add notes

πŸ§ͺ Testing

  • Unit Tests:

    • Input parsing
    • Roadmap generation
    • Resource recommendation
  • Integration Tests:

    • API endpoints

Run tests:

npm test

πŸ”„ DevOps Pipeline

This project implements a full 7-stage CI/CD pipeline:

  1. Build – Compile and package application
  2. Test – Run automated tests
  3. Code Quality – SonarQube analysis
  4. Security – Vulnerability scanning
  5. Deploy – Staging deployment
  6. Release – Production promotion
  7. Monitoring – Performance tracking

πŸ—ΊοΈ Roadmap (Features)

  • Career input parsing
  • Dynamic roadmap generation
  • Company-aware recommendations
  • Resource engine
  • Notes & progress tracking
  • Authentication system
  • Adaptive roadmap (AI refinement)
  • Gamification

🀝 Contributing

  1. Fork the Project
  2. Create a branch (feature/your-amazing-feature)
  3. Commit changes
  4. Push and open PR

πŸ“„ License

Distributed under the Apache 2.0 License.


πŸ“¬ Contact

Chi Vi Han – [email protected]

GitHub: https://github.com/Stewie-pixel/mirabile


About

mirabile.app is an AI agent that converts your dream career into a complete roadmap.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors