Skip to content

Tired of spending hours to and from school? Want to make the most out of that time before an exam? Introducing Flash.AI, your smart study companion, transforming travel time into productive time.

Notifications You must be signed in to change notification settings

Macpickle/Flash.AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flash.AI

Live Website
Please note it may take a few seconds to warm up the backend server to actually allow requests to be made.

Tired of spending hours to and from school? Want to make the most out of that time before an exam? Introducing Flash.AI, your smart study companion, transforming travel time into productive time. Whether it is a bus, train, or carpooling, Flash.AI helps you go through key concepts, quiz yourself, and build confidence-all hands-free. Ace your exams, wherever you are!

With Flash.AI, you can upload your notes, study slides, or any other documents to instantly generate AI-powered questions. Quiz yourself on the go, get smarter with every session, and turn your study materials into an interactive learning experience!

Features

We’ve packed Flash.AI with powerful features to help you ace your exams effortlessly. Here’s what you get:

  • Secure Accounts – Register and log in with confidence, protected by JWT authentication and Bcrypt encryption for top-notch security.
  • Anywhere Access – Upload your files (TXT, PDF, DOC, etc.) to our database and access them anytime, anywhere.
  • AI-Generated Quizzes – Turn your documents into custom quizzes to test your knowledge on the go, along with a question difficulty system to REALLY test your knowledge.
  • Smart Feedback – Get instant insights to track your progress and improve.
  • Search & Organize – Quickly find your documents with a built-in search bar. No more endless scrolling!
  • Mobile-Friendly – Study seamlessly on any device, whether you're on the bus or at home.
  • Customizable Themes – Prefer dark mode? Light mode? Switch effortlessly to match your style.
  • Full Account Control – Easily update your password, email, or username whenever you need

Tech Stack

along with:

  • Google Generative AI

How to Run

Since this is a local website, for now, you can run it off your own computer, or just view the live demo Live Website

Installation

First, you will need Node.JS, and a MongoDB database, along with a Google Generative AI Auth key

Then, you need to clone it to your local machine:

git clone https://github.com/Macpickle/Hackathon_Project.git

The Backend

First, open a new terminal.

Then, you need to enter the directory containing the backend, and then install all dependencies:

cd backend
npm i

Following this, you should be able to run the server:

npm run start

Congratulations! you've just ran our server, there is just one more step, Create a .env file and add the following variables, to your coresponding database, API key, and JWT auth key:

MONGODB_URI=YOUR_MONGODB_URI
GOOGLE_AI_API_KEY=YOUR_GOOGLE_AI_API_KEY
JWT_SECRET=YOUR_SECRET_KEY

The Frontend

Similar to the backend, you need to open a new terminal and then run these commands to go into the directory, and install all dependencies:

cd frontend
npm i

Following this, you should be able to run the server:

npm run start

Congratulations! you've just ran our frontend! You should be able to interact with our beautiful interface to test it out!

Developers

Dylan MacLeod
Jack Ma

About

Tired of spending hours to and from school? Want to make the most out of that time before an exam? Introducing Flash.AI, your smart study companion, transforming travel time into productive time.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •