Skip to content

thestamp/EnlightenAiTools

Repository files navigation

Enlighten AI Tools

Azure Static Web Apps CI/CD Azure Static Web Apps CI/CD

Welcome to Enlighten AI Tools, an open-source project dedicated to enhancing the way we study and interact with educational content.

The goal of this project is to provide a safe and innovative tool using AI (ChatGPT) that generates random questions from texts, guides learners to delve deeper into subjects, and tracks areas for improvement.

To try it out, go here: Enlighten AI Tools

Features

Enlighten AI Tools is comprised of two primary components:

  1. Student "Study" App:

    • Random question generation from textbook material.
    • Learning guidance through educational content.
    • Progress tracking to identify areas for improvement (WIP).
  2. Faculty "Admin" App:

    • Textbook content management and editing.
    • Tailored educational material provisioning.
    • Student progress monitoring (WIP).

Getting Started

Prerequisites

TBD - List of necessary prerequisites and dependencies.

Installation

To set up Enlighten AI Tools locally, follow these steps:

git clone https://github.com/thestamp/EnlightenAiTools
cd enlighten-ai-tools
# Follow up with installation steps

Docker

Alternatively, you can use Docker to pull the images of both apps:

# For the Student "Study" App
docker pull thestamp/enlighten-ai-tools-study:main

# For the Faculty "Admin" App
docker pull thestamp/enlighten-ai-tools-admin:main

Usage

TBD - Instructions and examples for using the "Study" and "Admin" apps.

Contributing

Interested in contributing? I'd love your help!

Development

TBD - Information on the tech stack, project structure, and how you can contribute to the development.

Roadmap

TBD - Upcoming features and improvements.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for more details.

Acknowledgments

TBD - Special thanks and credits.

Contact

For any support or queries, feel free to reach out to me at TBD.

Support

If you appreciate Enlighten AI Tools and would like to support the project, please consider starring the repo, forking or contributing!

About

Resources

License

Stars

Watchers

Forks

Contributors