.

AIStudy

An easily extendable RAG Application that allows you to interact with your documents in a fun and interactive manner, promoting understanding and engagement!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

AIstudy is an AI-powered chat app designed to enhance how you interact with documents and learn.

• Efficient Learning: AIstudy simplifies document comprehension by allowing you to ask natural language questions and receive instant, accurate answers, saving you valuable time.

• Enhanced Workflow: It eliminates repetitive tasks with a customizable template for interacting with document content, promoting efficiency and productivity.

• Personalized Engagement: Tailored quizzes based on your learning preferences ensuring a more engaging and effective learning experience.

AIstudy is custom built for an engaging document interaction and learning experience, making complex content accessible and enjoyable. Of course, your needs may be different. You may suggest changes by forking this repo and creating a pull request or opening an issue.

(back to top)

Built With

• Next.js
• React.js
• llama3 - A powerful large language model.
• qdrant - A high-performance vector search engine.
• langchain - A framework for developing applications powered by large language models.
• lablab-ai - An initiative designed to support and stimulate the modern AI ecosystem and the innovators behind it..

(back to top)

Getting Started

How to set up the project locally

Prerequisites

• npm

  npm install npm@latest -g

• AI/ML API key

Installation

1. Get an API Key at https://aimlapi.com/

2. Clone the repo

   git clone https://github.com/Hasbi-sabah/AIStudy.git

3. Install NPM packages

   npm install

4. Enter your API in a .env file

   API_KEY = 'ENTER YOUR API';

5. Run the development server:

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev
   # or
   bun dev

(back to top)

Usage

Here are some ways you can interact with the project:

1. Upload a document: You can upload a document and interact with its content using AIstudy.

2. Free interaction: AIstudy allows you to freely interact with the document content. Ask natural language questions and receive instant, accurate answers.

3. Quiz mode: Test your knowledge by taking quizzes based on the document content. AIstudy provides interactive quizzes to ensure an engaging and effective learning experience.

Feel free to explore the project and discover more features!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sabah Hasbi- @Hasbi-sabah - sabahhasbi00@gmail.com VIctor Langat - @victor_provich - provicml@gmail.com

Project Link: https://github.com/Hasbi-sabah/AIStudy

(back to top)

Acknowledgments

Acknowledgments

We would like to express our gratitude to the following individuals and organizations for their valuable contributions and support:

• My teammates - For their collaboration and unwavering support throughout the project.
• Lablab AI - For inspiring us with their innovative ideas during the hackathon challenge.
• MIT License - Providing the legal framework that ensures our project remains open and accessible.
• Team at Meta Llama3 - For their insightful contributions to the project's development.
• Img Shields - For providing badges that enhance the visibility of our project's status.
• Vercel - Enabling us to host our project documentation and showcase our work.

We extend our sincere thanks to everyone who has contributed to the success of this project and enriched our journey with their expertise and support.

(back to top)