Skip to content

k3vndev/studymate

Repository files navigation

Studymate

A modern web app designed to enhance self-learning with AI.

Create, follow, and complete Studyplans, track your progress, earn achievements to flex on your profile, and chat with Mate β€” your virtual assistant.

πŸš€ Built with Next.js, TypeScript, Zustand, Supabase, Zod, and TailwindCSS

πŸ’» Features

Dashboard

Your entry point after logging in.

  • View your current Studyplan
  • Start a new one
  • Chat with Mate instantly

If no Studyplan is selected, Mate greets you and suggests options. You can also browse and save Studyplans for later.

Dashboard preview

Chat

Here you will be interacting with Mate, your helpful and friendly virtual assistant πŸ‘Ύ

  • Generate new Studyplans
  • Get help with tasks
  • Ask for explanations or study tips
  • Track your progress in real time

Mate knows your current Studyplan, which day you're on, and your progress. Feel free to ask how to continue or complete tasks πŸͺ„

Chat preview

πŸ“š Studyplan

The core of Studymate. Start, manage, and complete your Studyplans here.

There's a card for the current day's lesson, and a list of all the lessons and tasks of the Studyplan regardless of the day so you know what's to come.

Studyplan preview

πŸ“œ You can create new Studyplans via chat or select existing ones from the dashboard.

Studyplan Tasks

Your daily execution layer.

  • View the day’s goal
  • Complete structured tasks
  • Ask Mate for help or hints

Finish all tasks β†’ get rewarded β†’ rest guilt-free πŸŽ‰

Tasks preview

🎯 Access via the β€œToday’s Lesson” card in the Studyplan page.

Focus Mode

Designed for deep work.

  • Built-in timer
  • Task list for the day
  • Quick task switching

Stay locked in. No excuses.

Focus preview

Profile

Track your grind. Build streaks. Flex consistency.

  • Stats & progress
  • Achievements & trophies πŸ†
  • Saved & completed Studyplans

Profile preview

βš™οΈ How It Works

Studyplans Lifecycle

  1. Created privately inside your chat with Mate
  2. Saved or started β†’ becomes public (anonymously)
  3. Other users can discover it in their dashboards
  4. Starting a Studyplan creates a personal copy

Studymate is not a social network β€” interaction is indirect via shared Studyplans.

πŸ› οΈ Local Setup

To run locally, you’ll need:

  • A Supabase instance
  • An OpenAI API key

1. Install dependencies

pnpm install

2. Create environment file

cp .env.example .env.local
# or on Windows:
Copy-Item .env.example .env.local

3. Fill in your keys

OPENAI_API_KEY=
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=
NEXT_PUBLIC_SUPABASE_URL=

4. Start the dev server

pnpm dev

🚧 Roadmap

Studymate is actively evolving.

πŸ“ƒ Planned features include:

  • User profiles [βœ“]
  • Achievements [Postponed]
  • Streak tracking [βœ“]
  • Study statistics [βœ“]
  • Chat messages deletion and editing
  • Mate responses streaming [βœ“]
  • Max days for Studyplans increase [βœ“]
  • Studyplans browsing

...and more cool stuff along the way.

πŸ™Œ Special Thanks

About

Enhance your self-learning with AI. Mate, your virtual assistant, will help you create, follow and complete personalized Studyplans πŸ€–πŸͺ„

Topics

Resources

License

Stars

3 stars

Watchers

2 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors