Skip to content

kz4killua/open-tutor-frontend

Repository files navigation

✨ Open Tutor: Everything you need to study with AI

Open Tutor aims to be a one-stop shop for AI-powered study tools. This was originally a hackathon project, but I have decided to take this a bit further. The goal is to make something I would actually use, and not just a gimmick.

Note

This repository contains code for the frontend of the Open Tutor application. You can check out the backend here.

What can it do?

A lot! Here are some of our features:

  • AI assistance whenever you need it: Get explanations, answers to questions, and much more with our powerful AI tutor. The AI tutor is built on GPT 4o, the latest in OpenAI's suite of large language models.
  • Intelligent flashcards that get you: Create flashcards at the click of a button. Flashcards can adjust to help you focus on your weaknesses.
  • Detailed progress reports: Get detailed feedback on your performance as well as suggested study areas.
  • more coming soon...

Where can I try it?

Here!

Can I run Open Tutor on my machine?

Absolutely! Follow these steps:

  1. Ensure you have the following installed:
  2. Install dependencies by running npm install.
  3. Set up a .env.local file in the root directory for this project. Refer to .env.example for more details.
  4. Run the development server.
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 with your browser to see the result.
  2. You probably want to run the backend application as well. Head over to the backend repository and follow the steps there too.

Can I contribute?

Yes please! Open Tutor is currently open (pun intended), and we welcome everyone to contribute.

About

Everything you need to study with AI

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published