Skip to content
This repository has been archived by the owner on May 20, 2024. It is now read-only.

sakshamshahu/AIEDS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to AIEDS ! Revise, Revisit, Unleash.


👋 Introduction

A tool which helps users control their learning process. AIDES harnesses the power of LLMs by providing text summaries and insights on user uploaded content. It also features active revision and quizing which makes learning even more fun and intuitive.Experience the convenience and efficiency of AI-driven solutions tailored to meet your needs. Join countless users worldwide who rely on our platform for enhanced productivity and seamless integration of AI technologies.


🌐 About The Project

Education has evolved from ancient oral traditions to modern digital platforms, reflecting humanity's quest for knowledge and progress. From classical education in ancient Greece and Rome to the standardized schooling of the Industrial Revolution, education has adapted to societal changes. The digital age has ushered in online learning platforms and personalized education, revolutionizing how we access and engage with educational content.

(Back to top)


🧰 Tech Stack Used

Docker SQLite Python Postgres react TypeScript tailwind Firebase

(Back to top)

🌟 Features

  1. Enhanced Accessibility: Ensure that educational resources are easily accessible to users. This involves designing an intuitive user interface and implementing features such as multilingual support and compatibility with different devices and screen sizes.

  2. Content Summarization: Develop advanced algorithms and deep learning techniques to distill complex educational materials, such as PDF documents, into concise and digestible summaries.

  3. Personalized Learning:: Implement features that allow for personalized learning experiences tailored to the individual needs and preferences of users. This includes adaptive learning algorithms that adjust content delivery based on user interactions.

  4. Interactive Engagement: Foster interactive engagement and collaboration among users through features such as discussion forums, peer-to-peer learning communities, and collaborative learning projects.

  5. Continuous Improvement: Establish mechanisms for continuous improvement and iteration based on user feedback and data analytics. This involves monitoring user interactions, tracking learning outcomes, and features to enhance the effectiveness.


🐺 Usage

Our project aims to revolutionize education by creating a learning platform that uses technology to simplify access to educational resources and improve learning outcomes for diverse users. Follow these steps to use it:

  1. Go to Playground: Navigate to the Playground section of our platform where you can interact with various tools and features.
  2. Add your PDF & Upload: Click on the upload button to add your PDF document. Ensure it is in the correct format for smooth processing.
  3. Let it analyze: Once uploaded, the system will automatically start analyzing the document. This may take a few moments depending on the size and complexity of the PDF.
  4. Ask your doubts: After the analysis is complete, you can ask specific questions or clarifications about the document. Use the interactive Q&A feature to get detailed responses.
  5. Result: View the results and summaries generated by the analysis. You can download or share these insights as needed.

By following these steps, you can effortlessly extract valuable insights from your documents, making your learning and research more efficient. Enjoy the convenience of our advanced AI-driven platform for all your document analysis needs.

(Back to top)


📁 Folder Format

AIEDS/
|-- AI/
|   |-- ai/
|   |-- chroma/
|   |-- tests/
|   |-- peotry.lock
|-- ...
|-- client/
|   |-- public/
|   |-- src/
|   |-- .gitignore
|   |-- package.json
|-- ...
|-- server/
|   |-- prisma/
|   |-- routes/
|   |-- index.ts
|-- ...
|-- docker/
|   |-- ai.dockerfile
|-- ...

🤝🏼 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. You are free to modify it whatever way you want. Just clone and enjoy 🚀. Please make sure to update tests as appropriate.

Instructions over how to Contribute.

Step 1. Install Git/ Github in your system. Fork the repository: This step creates a copy of the original repository under your GitHub account.

git clone https://github.com/sakshamshahu/AIEDS.git
cd AIEDS

Step 2 . Create a new branch: It's recommended to create a new branch for your contribution. This helps keep your changes separate from the main branch.

git checkout -b my-branch

Step 3. Make and commit your changes: Write your code or make the necessary modifications to the files in the repository. Once you're done, commit your changes with a meaningful message describing the changes you made.

git add .
git commit -m "Add my contribution"

Step 4. Sync with the original repository: Keep your forked repository in sync with the original repository to incorporate any recent changes made by other contributors.

git remote add upstream https://github.com/sakshamshahu/AIEDS.git
git fetch upstream
git merge upstream/main

Step 5. Push your changes and create a pull request: Push your branch with the committed changes to your forked repository. Then, create a pull request to propose your changes to the original repository.

git push origin my-branch

After pushing your changes, you can visit the original repository's page on GitHub or the respective hosting platform. From there, you can create a pull request by following the prompts.

Note that these commands assume you're using HTTPS to clone and push to the repository. If you have set up SSH keys, you can use the SSH URL instead for cloning and pushing.

(Back to top)


🏆 Contributors


(Back to top)

© 2024 AIEDS. All rights reserved.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •