Home

Welcome to RunOn!

Project Overview

RunOn! is currently in MVP development with a backend-first approach, focusing on core functionality and test coverage.

MVP Status

• Current Phase: Backend Development
• Focus: 100% Test Coverage
• Key Features:
  • Event discovery using Google Search API
  • Google Calendar integration
  • Simple user authentication

Project Structure - Backend

RunOn/
├── .github/
│   └── workflows/
│       └── build.yml       # CI/CD pipeline
├── backend/
│   ├── functions/          # Core functionality
│   ├── models/             # Data models
│   ├── tests/              # Test suite
│   └── scripts/            # Development tools
└── README.md

Documentation

MVP Documentation

• MVP Overview
• MVP Architecture
• MVP Implementation
• MVP Testing Strategy

Core Documentation

• Development Guide
• API Specifications
• Infrastructure

Quality Metrics

Getting Started

1. Clone the repository

   git clone https://github.com/fleXRPL/RunOn.git
   cd RunOn

2. Set up development environment

   cd backend
   pip install -r requirements.txt
   pip install -r requirements-dev.txt

3. Run tests and checks

   bash scripts/format_and_lint.sh
   

Android Development

git clone https://github.com/fleXRPL/RunOn.git
cd RunOn
./android/scripts/setup.sh

Project Structure - Android

android/
├── app/                            # Main application module
│   ├── src/
│   │   ├── main/kotlin/
│   │   │   └── com/flexrpl/runon/
│   │   │       ├── data/           # Data layer: repositories & models
│   │   │       ├── domain/         # Business logic & use cases
│   │   │       └── ui/             # Presentation layer using Jetpack Compose
│   │   └── test/                   # Unit & integration tests
│   └── config/                     # Project configuration
└── scripts/                        # Development & CI/CD scripts

Key Features:

• Clean Architecture implementation
• Jetpack Compose UI
• 100% Kotlin codebase
• Comprehensive test coverage

Contact

Project Lead: garotm
Repository: fleXRPL/RunOn

License

This project is licensed under the MIT License - see the LICENSE file for details.