Skip to content

song-richard/academa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Academa

Description

Academa is an innovative learning platform designed for students and learners who benefit from repetition and active recall. By leveraging the latest in AI technology, Academa allows users to create and utilize flashcards for studying more efficiently. Alongside the dynamic flashcard generation feature, Academa offers an AI chatbot capable of handling a wide range of questions to assist users in building their study materials. Our application ensures that your learning process is personalized, interactive, and above all, effective.

Table of Contents

Installation

  1. Clone the repository:
    git clone 
    
  2. Install Dependencies npm install

or

yarn install

  1. Set up .env OPENAI_API_KEY=your_api_key_here

  2. Start application npm run dev

or

yarn dev

Usage

Visit the site at https://academa-zkud.onrender.com. After signing up or logging in, navigate to the "Create Flashcard" or "Generate AI Flashcard" components to begin building your study materials. The AI chatbot is available for any inquiries or assistance needed in creating flashcards.

image image image image

Technology Used

JavaScript NodeJS MongoDB Nodemon React Vite Render Visual Studio Code Figma JWT MUI Apollo GraphQL npm Tailwind Notion GitHub Open AI

Features

  • Dynamic Flashcard Generation: Create flashcards with terms and descriptions generated by OpenAI, tailored to your study material.
  • AI Chatbot: An interactive chatbot powered by OpenAI, ready to answer any questions and help you build comprehensive flashcards.
  • User Authentication: Securely sign up or log in to save your progress and access your personalized flashcards from anywhere.
  • Modern Technology Stack: Built with the latest versions of MongoDB, Express, React, Node.js, and integrated with Apollo Server and GraphQL for a seamless user experience. We also utilize Vite for an optimized development experience, with deployment on Render and Netlify.
  • Version Control with GitHub: Ensuring that development is streamlined and collaborative.

How to Contribute

Message us!

Contact

https://github.com/song-richard https://github.com/Pak547 https://github.com/Kal-a11y https://github.com/berheamanuel

License

PyPi license



Back to top

Currently, two official plugins are available:

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Attribution

Image by freepik