Skip to content

AmanuelCh/DiscipleTrack

Repository files navigation

DiscipleTrack - Discipleship Journey Tracker

A comprehensive spiritual growth application designed to help believers develop consistent spiritual disciplines, track their progress, and deepen their relationship with God through structured learning, reflective journaling, and habit formation.

Features

Structured Learning

  • Topic-Based Curriculum: Organized spiritual topics covering essential areas of faith
  • Interactive Lessons: Engaging content with Bible references and practical applications
  • Progress Tracking: Monitor completion status and maintain learning streaks
  • Custom Content: Add your own topics and lessons alongside curated content

Spiritual Journaling

  • Rich Text Editor: Full-featured writing experience with formatting options
  • Categorized Entries: Organize reflections by Prayer, Gratitude, Struggles, Breakthroughs, etc.
  • Tagging System: Tag entries with themes like Faith, Growth, Worship, Scripture
  • Lesson Integration: Create journal entries directly from completed lessons
  • Search & Filter: Find past entries by date, category, tags, or content

Habit Tracking

  • Daily Spiritual Disciplines: Track Prayer, Bible Reading, Journaling, Fellowship, Meditation, Service
  • Visual Progress: See completion rates and streaks at a glance
  • Custom Habits: Add personalized spiritual practices
  • Daily Notes: Record insights and reflections for each day
  • Historical View: Review past performance and identify patterns

Achievement System

  • Learning Milestones: Unlock achievements for lesson completion and topic mastery
  • Consistency Rewards: Celebrate streaks and regular engagement
  • Journaling Recognition: Achievements for writing frequency and depth
  • Habit Mastery: Recognition for maintaining spiritual disciplines
  • Well-Rounded Growth: Special achievements for balanced spiritual development

Progress Dashboard

  • Personal Statistics: View total lessons, journal entries, active days, and current streaks
  • Today's Focus: Quick overview of daily habit progress and completion rates
  • Recent Activity: Easy access to recently completed lessons and journal entries
  • Quick Actions: One-click access to study, journal, track habits, or view achievements

Customization & Settings

  • Habit Management: Enable/disable habits, customize descriptions and colors
  • Theme Support: Light and dark mode for comfortable use any time
  • Data Import and Export: Import or backup your spiritual journey data
  • Keyboard Shortcuts: Navigate the app using keyboard shortcuts
  • Command Palette: Access quick actions and settings using keyboard shortcuts
  • Responsive Design: Seamless experience across desktop, tablet, and mobile devices

Getting Started

Prerequisites

  • Node.js 18+

Installation

  1. Clone the repository

    git clone https://github.com/AmanuelCh/DiscipleTrack.git
    cd DiscipleTrack
  2. Install dependencies

    npm install
    # or
    yarn install
    # or
    pnpm install
  3. Start the development server

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
  4. Navigate to http://localhost:3000

Technology Stack

  • Framework: Next.js 15 with App Router
  • Language: TypeScript
  • Styling: Tailwind CSS
  • Database: IndexedDB with Dexie.js
  • Icons: Heroicons
  • Markdown: React Markdown
  • Themes: next-themes

Privacy & Data

  • Local Storage: All data remains on your device
  • No Account Required: Start using immediately without registration
  • Data Control: Export your data anytime

Contributing

Contributions are welcomed. Feel free to:

  • Report bugs or suggest features via GitHub Issues
  • Submit pull requests for improvements
  • Share feedback on the user experience
  • Contribute additional spiritual content or topics

Important Versioning Guidelines

⚠️ Database Changes: If you make any changes to the database schema, structure, or add/remove tables:

  • MUST increment the Dexie version in app/lib/database.ts
  • This ensures proper database migrations for existing users
  • Failure to do this can cause data corruption or app crashes

⚠️ Content Updates: If you modify, add, or remove default content (topics, lessons, categories, etc.):

  • MUST increment the version in content.json
  • This triggers content updates for users who have the app being used
  • Ensures all users receive the latest curated content

Version Increment Examples

// In app/lib/database.ts - increment when DB changes
export const db = new Dexie('DiscipleTrackDB');
db.version(2).stores({ // Increment from 1 to 2
  // ... your schema changes
});

// In content.json - increment when content changes
{
  "version": 3, // Increment from 2 to 3
  "topics": [...],
  // ... your content changes
}

License

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

Why I built this

  • Inspired by the need for digital tools that support authentic spiritual growth
  • Built with gratitude for the open-source community

About

a spiritual growth app that helps Christians build consistent habits and deepen their walk with God

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published