Skip to content

goatly-space/goatly

Repository files navigation

Mr Goatly

Goatly - Focus, Rise, Organize, Grow, Overcome

License Version Community Language Framework

🌟 An open-source community-driven study time management platform built by students, for students.

Live Demo GitHub Discord

📖 Table of Contents

🌟 About

Goatly is more than just a study timer—it's a comprehensive open-source platform designed to help students achieve deep focus and academic excellence through community-driven tools and collaborative learning.

Our Mission

"Focus Together, Succeed Together" - We believe that the power of community can transform individual study habits into collective success.

What Makes Goatly Different

  • 🌍 Community-Driven: Built by students, for students
  • 🔓 Open Source: Transparent, customizable, and free forever
  • 🎯 Focus-Oriented: Designed specifically for deep work and concentration
  • 📊 Data-Driven: Smart analytics to track and improve study patterns
  • 🤝 Collaborative: Learn from peers and share success strategies

� The Mr. Goatly Philosophy

"The secret isn't in jumping a lot... The secret is in jumping in the right direction."

This simple yet profound principle guides everything we build - every feature, every timer, every achievement is designed to help you make your next jump count.

✨ Features

🎯 Core Study Tools

Feature Description
🧘 Deep Focus Mode Community-tested techniques for achieving maximum concentration
📈 Smart Goal Tracking Set, track, and achieve academic goals with peer support
🔥 Streak Tracking Maintain consistent study habits with community accountability
📊 Progress Analytics Visual insights into your study patterns and improvement areas

🌟 Community Features

Feature Description
💬 Peer Support Network Connect with motivated students worldwide
🏆 Community Challenges Participate in focus challenges and competitions
📚 Shared Resources Access community-curated study materials and techniques
🎓 Success Stories Learn from real experiences of fellow students

🛠️ Technical Features

Feature Description
🌙 Dark/Light Themes Comfortable studying in any environment
📱 Responsive Design Study on any device, anywhere
🔄 Real-time Updates Live progress tracking and community interactions
🔐 Privacy-First Your data is yours - we don't sell or share it

⚡ Advanced Features

  • 📊 Real-time Leaderboard - Live ranking with Supabase real-time subscriptions
  • ⏱️ Smart Timer System - Multiple timer types (YouTube, Pomodoro, Custom)
  • 🎮 Gamification System - Coins, achievements, and avatar customization
  • 💾 Smart Data System - Supabase database with device identification
  • 🔐 Secure Authentication - bcryptjs-based password hashing and session management
  • 📧 Email Integration - Brevo API for newsletters and notifications
  • 📈 Analytics Dashboard - Recharts-powered data visualization
  • 👥 Admin Panel - Complete admin dashboard for user and content management

🚀 Quick Start

Prerequisites

  • Node.js 20+
  • npm or yarn
  • Git
  • Supabase account

Installation

# Clone the repository
git clone https://github.com/izzeldeenn/goatly.git
cd goatly

# Install dependencies
npm install

# Copy environment variables
cp .env.example .env.local

# Start development server
npm run dev

Environment Setup

Create a .env.local file with:

NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key

Running the App

# Development mode (with webpack)
npm run dev

# Build for production
npm run build

# Start production server
npm start

# Run linter
npm run lint

Visit http://localhost:3000 to see Goatly in action!

🛠️ Tech Stack

Frontend

  • ⚛️ Next.js 16 - React framework with App Router
  • ⚛️ React 19 - Latest React with React Compiler
  • 📘 TypeScript - Type-safe development
  • 🎨 Tailwind CSS 4 - Utility-first styling with PostCSS
  • 🎨 Lucide React - Beautiful icon library
  • 📊 Recharts - Data visualization and charts

Backend & Database

  • 🗄️ Supabase - PostgreSQL database & real-time features
  • 🔐 bcryptjs - Password hashing and security
  • � crypto-js - Encryption utilities
  • 📧 Brevo API - Email marketing and notifications
  • 📊 Real-time Subscriptions - Live updates via Supabase

Development Tools

  • 📦 ESLint 9 - Code quality and linting
  • 🔧 React Compiler - Automatic React optimizations
  • 🚀 Vercel Analytics - Performance monitoring
  • 🛠️ Supabase CLI - Database management

Architecture

src/
├── app/                 # Next.js App Router
│   ├── api/            # API routes
│   ├── focus/          # Main application
│   ├── admin/          # Admin dashboard
│   ├── extension/      # Browser extension page
│   ├── about/          # About page
│   ├── blog/           # Blog section
│   ├── challenge/      # Challenges page
│   ├── pricing/        # Pricing page
│   └── page.tsx        # Landing page
├── components/         # Reusable UI components
├── contexts/          # React contexts (User, Theme, Language, Coins)
├── hooks/             # Custom React hooks
├── lib/               # Library functions and utilities
├── database/          # Database configurations
├── constants/         # App constants
└── styles/            # Global styles

🤝 Contributing

We welcome contributions from everyone! Whether you're a developer, designer, or student passionate about focus and productivity.

🎯 How to Contribute

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch
    git checkout -b feature/amazing-feature
  3. 💫 Make your changes
  4. ✅ Test thoroughly
  5. 📤 Commit and push
    git commit -m 'Add amazing feature'
    git push origin feature/amazing-feature
  6. 🔄 Create a Pull Request

🏷️ Contribution Areas

  • 🐛 Bug Fixes: Help us squash those bugs!
  • ✨ New Features: Suggest and implement new study tools
  • 📚 Documentation: Improve our docs and README
  • 🎨 Design: UI/UX improvements and themes
  • 🌍 Translation: Help us reach more students worldwide

📋 Development Guidelines

  • Follow the existing code style and conventions
  • Write tests for new features
  • Update documentation when necessary
  • Be respectful and constructive in PR discussions

📊 Community Impact

📈 Our Growing Community

Metric Current Goal
👥 Community Members 1,000+ 10,000+
📚 Study Hours Tracked 50,000+ 1,000,000+
🎯 Goals Achieved 5,000+ 100,000+
🌍 Countries Represented 25+ 100+

🏆 Success Stories

"This community transformed my academic life. The open-source approach and peer support kept me accountable and focused." - Ahmed Mohammed, Computer Science Student

"Being part of this community made all the difference. We share techniques, motivate each other, and celebrate success together." - Sarah Ahmed, Medical Student

"The collaborative environment and open-source tools helped me develop sustainable study habits and achieve my goals." - Mohammed Ali, Engineering Student

🔧 Development

📋 Available Scripts

Command Description
npm run dev Start development server (with webpack)
npm run build Build for production
npm run start Start production server
npm run lint Run ESLint

🧪 Testing

Testing framework setup is in progress. Coming soon!

🚀 Deployment

Goatly is deployed on Vercel for seamless integration:

# Deploy to Vercel
vercel --prod

📱 User Interface

Main Features

  • Focus Timer - Start/stop timer with multiple modes
  • Leaderboard - Real-time ranking with user profiles
  • User Settings - Profile customization and theme settings
  • Admin Dashboard - User management and analytics
  • Browser Extension - Productivity tools integration
  • Blog & Resources - Educational content
  • Challenges - Community focus challenges
  • Pricing - Premium features and plans

🌟 Roadmap

🚀 Upcoming Features

  • 🎮 Gamification - Points, badges, and leaderboards ✅
  • 📱 Mobile App - Native iOS and Android applications
  • 🤖 AI Study Assistant - Personalized study recommendations
  • 👥 Study Groups - Create and join focused study groups
  • 📝 Note Integration - Connect with popular note-taking apps
  • 🔔 Smart Notifications - Intelligent reminder system
  • 🧪 Testing Suite - Comprehensive test coverage

🌍 Community Goals

  • 🌐 Multi-language Support - English and Arabic ✅
  • 🏫 School Integration - Partner with educational institutions
  • 📚 Resource Library - Comprehensive study material collection
  • 🎓 Certification Program - Recognize study achievements

📄 License

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

🤝 What MIT Means

  • Freedom: Use, modify, and distribute freely
  • Commercial Use: Use in commercial projects
  • No Warranty: Use at your own risk
  • Attribution: Include original license and copyright

🙏 Acknowledgments

🌟 Special Thanks

  • 👥 Our Community Contributors - Everyone who helped build Goatly
  • 🎨 Design Inspiration - Modern productivity and focus apps
  • 📚 Educational Resources - Study techniques and research
  • 🛠️ Open Source Community - Tools and libraries that make this possible

📚 Resources & Inspiration

📞 Get in Touch

🌐 Connect With Us

Platform Link
🚀 GitHub github.com/izzeldeenn/GOATLY
💬 Discord discord.gg/5wBNne8Z3f
🌐 Live Demo goatly.space
📧 Email support@goatly.app

🎯 Join Our Mission

Become part of a growing movement of students committed to focus, learning, and mutual success. Whether you want to:

  • 🛠️ Contribute Code - Help us build better features
  • 📝 Share Feedback - Tell us what works and what doesn't
  • 🌍 Spread the Word - Help other students discover Goatly
  • 🤝 Partner With Us - Schools, organizations, and communities

Your journey starts here. Together, we focus, rise, organize, grow, and overcome with Goatly.


⭐ Star this repo if it helped you focus better!

Made with ❤️ by the Goatly Community

"great of all time"

� "The secret isn't in jumping a lot... The secret is in jumping in the right direction." - Mr. Goatly

About

goatly is an educational platform built around a community-driven ethical digital economy. It is designed to help students learn, stay consistent, and grow through challenges, collaboration, and a reward-based system.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors