Skip to content

neurodivergent-dev/Aurora

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŒ… Aurora

AI DJ for Your Mind & Music

A minimalist, offline-first music player with AI-powered personalization. Experience your music like never before with an intelligent DJ that understands your vibe.

Version Platform License Tests Docs


πŸ“š Documentation

Guide Description
πŸ—οΈ Architecture High-level overview, state management, navigation
🧩 Components Component types, patterns, best practices
πŸ›‘οΈ Error Handling Result type pattern, user-facing errors
πŸ“ Logger Logging setup, usage, production logging
πŸ§ͺ Testing Unit tests, integration tests, CI/CD
🀝 Contributing How to contribute, coding standards

New to Aurora? Start with Architecture β†’ Components β†’ Testing


✨ Features

🎡 Music Playback

  • Play local music files from your device
  • Create and manage custom playlists
  • Shuffle and repeat modes
  • Beautiful full-screen player with lyrics support
  • Mini player for seamless multitasking

πŸ€– AI DJ

  • Multi-Provider Support: Google Gemini, Groq, and local Ollama models
  • Natural Control: Chat with your AI to change themes, add music, adjust settings
  • Custom Personas: Define your AI's personality
  • Smart Actions: AI can execute app commands through conversation
  • Chat History: Last 50 messages saved locally

🎨 Theme System

  • 35+ Premium Themes: Cyberpunk, Matrix, Cosmos, Nebula, and more
  • Dynamic Themes: Music rhythm-based theme transitions
  • Custom Themes: Create themes with AI or manually
  • Light/Dark/System mode support

🌊 Background Effects

  • 18+ Animated Effects: Bokeh, Quantum, Waves, DNA, Matrix, and more
  • Dynamic Switching: Effects respond to your music
  • Custom Effects: AI-generated background configurations

πŸ”’ Privacy First

  • 100% Offline: No internet required (except AI features)
  • Zero Data Collection: Your data stays on your device
  • Local Storage: SQLite + MMKV for fast, secure storage
  • No Ads: Clean, uninterrupted experience

🌍 Internationalization

  • English and Turkish support
  • Auto-detect device language
  • Easy to extend with more languages

πŸ”’ Security Note

Local Network Connections (HTTP)

For local AI integration (Ollama and Stable Diffusion), Aurora uses standard HTTP connections to communicate with services running on your local machine or LAN.

  • Ollama: Connects via http://[IP]:[PORT]/api/chat
  • Stable Diffusion: Connects via http://[IP]:[PORT]/sdapi/v1/txt2img

Important

Since these connections are unencrypted (HTTP), they are intended for use within trusted local networks only. If exposing these services over a public network, it is highly recommended to use a reverse proxy with HTTPS (like Nginx or Caddy).


πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Expo CLI
  • iOS Simulator (Mac) or Android Emulator

Installation

# Clone the repository
git clone https://github.com/neurodivergent-dev/aurora.git
cd aurora

# Install dependencies
npm install

# Start the development server
npm start

# Run on iOS
npm run ios

# Run on Android
npm run android

# Run on Web
npm run web

Clean Install (if needed)

# Windows PowerShell
.\clean-reinstall.ps1

# Reset Metro cache
.\reset-metro.ps1

πŸ“± Screenshots

Add your screenshots here:

  • assets/screenshots/home.png
  • assets/screenshots/player.png
  • assets/screenshots/ai-chat.png
  • assets/screenshots/themes.png

πŸ—οΈ Tech Stack

Category Technology
Framework React Native + Expo SDK 55
Language TypeScript
Navigation expo-router (file-based)
State Zustand + persist middleware
Storage MMKV, AsyncStorage, SecureStore
Database expo-sqlite
AI Google Gemini, Groq, Ollama
Media expo-av
Animations react-native-reanimated
Icons lucide-react-native
i18n i18next + react-i18next
Testing Jest + Testing Library

πŸ“‚ Project Structure

aurora/
β”œβ”€β”€ app/                    # Expo Router screens
β”‚   β”œβ”€β”€ (tabs)/            # Tab navigation
β”‚   β”‚   β”œβ”€β”€ index.tsx      # Library
β”‚   β”‚   β”œβ”€β”€ playlists.tsx
β”‚   β”‚   β”œβ”€β”€ ai-chat.tsx
β”‚   β”‚   └── settings.tsx
β”‚   β”œβ”€β”€ music-player.tsx
β”‚   └── _layout.tsx
β”‚
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/        # Reusable UI components
β”‚   β”œβ”€β”€ screens/           # Screen components
β”‚   β”œβ”€β”€ store/             # Zustand stores
β”‚   β”œβ”€β”€ services/          # Business logic
β”‚   β”œβ”€β”€ lib/               # Core utilities (database)
β”‚   β”œβ”€β”€ hooks/             # Custom hooks
β”‚   β”œβ”€β”€ utils/             # Helper functions
β”‚   β”œβ”€β”€ constants/         # Themes, categories, prompts
β”‚   └── i18n/              # Translations
β”‚
β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ images/            # Icons, splash screens
β”‚   β”œβ”€β”€ fonts/             # Custom fonts
β”‚   └── sounds/            # Default music tracks
β”‚
β”œβ”€β”€ scripts/               # Build scripts
β”œβ”€β”€ scripts/               # Build scripts
└── package.json

🎯 Configuration

AI Setup

To use AI features, configure your API keys in the app settings:

  1. Open Settings β†’ AI Settings
  2. Choose your provider (Gemini, Groq, or Ollama)
  3. Enter your API key
  4. Start chatting with your AI DJ

Package ID

  • iOS Bundle ID: com.metaframe.aurora
  • Android Package: com.metaframe.aurora

To change, update app.json and rebuild.


πŸ§ͺ Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run in CI mode
npm run test:ci

# Type check
npm run typecheck

# Lint
npm run lint

Coverage Targets

Directory Target Status
src/utils 80% βœ… 70%
src/store 80% 🟑 40%
src/hooks 70% 🟑 30%
src/services 70% 🟑 25%
Overall 30% 🟑 ~10%

πŸ“– Learn More: Testing Best Practices


πŸš€ Building for Production

Android

# Build APK
eas build --platform android --profile preview

# Build for Play Store
eas build --platform android --profile production

iOS

# Build for TestFlight
eas build --platform ios --profile production

EAS Configuration

See eas.json for build profiles.


πŸ“„ Features Roadmap

  • Spotify/Apple Music integration
  • Smart playlists (AI-generated)
  • Social sharing features
  • Widget support
  • CarPlay / Android Auto
  • More AI providers (Claude, local LLMs)
  • Advanced audio EQ
  • Sleep timer with fade-out

🀝 Contributing

Contributions are welcome! We appreciate all types of contributions:

  • πŸ› Bug reports
  • πŸ’‘ Feature suggestions
  • πŸ“ Documentation improvements
  • πŸ§ͺ Test additions
  • 🎨 Design enhancements
  • 🌍 Translations

Getting Started

  1. Read Contributing Guide
  2. Read Architecture Overview
  3. Fork the repository
  4. Create a feature branch (git checkout -b feature/amazing-feature)
  5. Make your changes (follow coding standards)
  6. Write tests (see Testing Guide)
  7. Commit your changes (git commit -m 'feat: add amazing feature')
  8. Push to the branch (git push origin feature/amazing-feature)
  9. Open a Pull Request

Code Style

  • βœ… TypeScript for all code
  • βœ… ESLint + Prettier configured
  • βœ… Logger instead of console.log
  • βœ… Error handling with Result type
  • βœ… Accessibility labels on touchables
  • βœ… Tests for new features

πŸ“– Full Guide: CONTRIBUTING.md


πŸ“ License

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


πŸ‘¨β€πŸ’» About MetaFrame

Aurora is developed by MetaFrame, a studio focused on creating smart tools for modern life.

Other Apps by MetaFrame

  • FocusTabs - Productivity & Focus
  • Mindbook Pro - Mental Health & Journaling
  • Mindbook Trial - Free version
  • Aurora - AI Music Player (this app)

🌐 Publisher Page: APPLION - MetaFrame


πŸ“š Additional Resources

Documentation

Project Status

Learn More


πŸ“¬ Contact


Made with ❀️ and AI

"Your music, amplified by intelligence."

About

Synth your vibe with Aurora

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors