An innovative educational platform designed to revolutionize the way people learn. It offers personalized learning experiences tailored to individual needs, making education more engaging and effective.
A platform that allows learners to maximize the existing Artificial Intelligence (AI) through the provision and generation of learning materials; allowing users to have a personalized learning experience based on their goals and interests.
Table of Contents
Before running the application, make sure to install the following:
-
NodeJS (NPM).
Download through their official docs.
npm install npm@latest -g
-
Mongo DB
Download through their official docs.
-
Python 3
Download through their official website.
# Clone this repository
git clone https://github.com/STUBU-AI/STUBU-CLIENT.git
# Upon cloning, navigate to the repo.
cd STUBU-CLIENT
# Install NPM packages
npm install# Start the application
npm run dev# Clone this repository
git clone https://github.com/STUBU-AI/STUBU-API.git
# Upon cloning, navigate to the repo.
cd STUBU-API
# Install and use specified node version
nvm install
# Install NPM packages
npm install
# Create a copy of sample .env file
cp .sample.env .env# Run the server
npm start
# Restarts the server on any changes made in the project
npm run dev
# Run the unit test
npm run test# Clone this repository
git clone https://github.com/STUBU-AI/RAG-LLM.git
# Upon cloning, navigate to the repo.
cd RAG-LLM
# Go to OpenAI and create a new API key. Create a .env file and add your OPENAI_API_KEY.
sudo pip3 install -r requirements.txt# Locally
# Open a terminal, navigate to repo and run:
chroma run
# Open another terminal, navigate to repo and run:
uvicorn app.app:app --port 8001
# Using Docker
docker-compose up -d| Number | Feature | Definition |
|---|---|---|
| 1 | Landing Page | The initial page users see when they visit the platform. |
| 2 | Onboarding Page | A page or series of pages designed to familiarize new users with the platform. |
| 3 | Authentication: Login and Sign-up | The process of verifying the identity of users and allowing them to access the platform by logging in or signing up. |
| 4 | Learner's Personalization | Customization of the learning experience based on individual user preferences and behavior. |
| 5 | Content Course Generation | The process of creating/generating custom personalized course content. |
| 6 | Bookmark Course | Allowing users to save or bookmark public courses for easy access later. |
| 7 | Upvote Course | Allowing users to express their approval or appreciation for public courses by voting them up. |
| 8 | Quiz Generation | The process of generating quizzes or assessments for courses on the platform. |
| 9 | Course Assessment | Assessments designed to evaluate a learner's understanding and knowledge of course material. |
| 10 | Material Submission | The process of submitting materials or resources for a course. |
We greatly appreciate contributions to this project. Special thanks to the following contributors for their valuable input and efforts:
- Kevin Vega
- Jobb Rodriguez
