Skip to content

README.md

Latest commit

 

History

History
134 lines (95 loc) · 4.42 KB

README.md

File metadata and controls

134 lines (95 loc) · 4.42 KB

📚 StudyPal

Your personal study companion — built for students who mean business.

StudyPal helps you organize daily tasks, beat procrastination with Pomodoro timers, track your progress with stats, and build better study habits — one focused session at a time.

React Native Expo TypeScript NativeWind

✨ Features

  • 📋 Task Management — Add, organize, and track your daily study tasks from a clean dashboard
  • 📅 Schedule View — See your study sessions laid out by day so nothing slips through
  • ⏱ Pomodoro Timer — Built-in focus timer to help you work in productive sprints and beat procrastination
  • 📊 Stats & Insights — Visualize your study habits and track consistency over time
  • 📝 Notes — Capture quick thoughts, summaries, or anything you don't want to forget
  • 🎨 Custom Tab Bar — Floating action button with a smooth, modern bottom navigation UI
  • 📱 Cross-platform — Runs on Android and iOS from a single codebase

🛠 Tech Stack

Layer Technology
Framework React Native + Expo
Language TypeScript
Routing Expo Router (file-based)
Styling NativeWind v4 (Tailwind CSS for RN)
Bundler Metro
Linting ESLint

📁 Project Structure

StudyPal/
├── app/                    # File-based routes (Expo Router)
│   ├── _layout.tsx         # Root layout with custom tab bar
│   ├── index.tsx           # Home / dashboard screen
│   ├── schedule.tsx        # Daily schedule screen
│   ├── AddTask.tsx         # Add new task screen (FAB route)
│   ├── stats.tsx           # Study stats & analytics screen
│   └── notes.tsx           # Notes screen
├── components/
│   └── TabBar.tsx          # Custom floating tab bar component
├── assets/
│   └── icons/              # App icon assets (home, calendar, stats, edit)
├── app.json                # Expo app configuration
├── tailwind.config.js      # Tailwind / NativeWind configuration
├── babel.config.js         # Babel configuration
├── metro.config.js         # Metro bundler configuration
├── tsconfig.json           # TypeScript configuration
└── nativewind-env.d.ts     # NativeWind type declarations

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository

    git clone https://github.com/MONISHA2876/StudyPal.git
cd StudyPal

  2. Install dependencies

    npm install

  3. Start the development server

    npx expo start

  4. Run the app

    Scan the QR code with Expo Go (Android) or your Camera app (iOS), or press:

    • a — open on Android emulator
    • i — open on iOS simulator

📱 Screens

Screen Route Description
Home / Dashboard with today's tasks and quick overview
Schedule /schedule Calendar-style daily schedule view
Add Task /AddTask Form to create a new study task (opened via FAB)
Stats /stats Study session analytics and habit tracking
Notes /notes Freeform notes and quick captures

🎨 UI Design

StudyPal features a custom floating tab bar with:

  • A red floating action button (+) that opens the Add Task screen
  • Purple active state tinting for selected tab icons
  • A card-style bottom nav with rounded corners and a soft shadow
  • Smooth activeOpacity press feedback on all interactive elements

Made with ❤️ by Monisha