Skip to content

PappyZero/schooltry-edtech

Repository files navigation

SchoolTry EdTech Platform

Laravel Vue.js Tailwind CSS

SchoolTry is an educational technology platform that leverages AI to enhance the learning experience. This application allows students to ask questions about their lessons and receive AI-generated responses, making learning more interactive and engaging.

🚀 Features

  • Interactive Lessons: Browse and view educational content
  • AI-Powered Q&A: Get instant answers to your questions
  • User Authentication: Secure login and registration system
  • Admin Dashboard: Manage lessons and content with ease
  • Responsive Design: Works on desktop and mobile devices

🤖 AI Integration

This application integrates with the following AI services:

  • Hugging Face - For natural language processing and question-answering capabilities
  • OpenRouter - For accessing various AI models including GPT-3.5 and Claude

The AI analyzes lesson content and provides contextual, accurate responses to student questions, enhancing the learning experience.

🛠️ Tech Stack

  • Backend: Laravel 10.x
  • Frontend: Vue.js 3, Inertia.js
  • Styling: Tailwind CSS
  • Database: SQLite (can be configured for MySQL/PostgreSQL)
  • AI Services: Hugging Face, OpenRouter
  • Deployment: Ready for Laravel Forge, Vercel, or traditional hosting

📋 Prerequisites

  • PHP 8.1 or higher
  • Composer
  • Node.js 16+ & NPM
  • SQLite (or MySQL/PostgreSQL)
  • Hugging Face API Key (optional)
  • OpenRouter API Key (optional)

🚀 Installation

  1. Clone the repository

    git clone https://github.com/PappyZero/schooltry-edtech.git
    cd schooltry-edtech
  2. Install PHP dependencies

    composer install
  3. Install JavaScript dependencies

    npm install
  4. Create and configure .env file

    cp .env.example .env
    php artisan key:generate
  5. Configure database

    touch database/database.sqlite
    

    Update .env with your database configuration.

  6. Run migrations and seeders

    php artisan migrate --seed
  7. Compile assets

    npm run build
  8. Start the development server

    php artisan serve
  9. Start the Queue Worker in another terminal

    php artisan queue:work
  10. Access the application Open your browser and visit: http://localhost:8000

🔐 Default Admin Account

🌐 Environment Variables

Create a .env file and configure the following variables:

APP_NAME="SchoolTry Learning Assistant"
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost

# Database Configuration
DB_CONNECTION=sqlite
DB_DATABASE=/path/to/your/database.sqlite

# AI Configuration
HUGGINGFACE_API_KEY=your_huggingface_api_key_here
HUGGINGFACE_MODEL=google/flan-t5-base
OPENROUTER_API_KEY=your_openrouter_api_key_here
OPENROUTER_MODEL=openai/gpt-3.5-turbo

🧪 Testing

Run the test suite with:

php artisan test

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  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

📄 License

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

📧 Contact

Your Name - @Pappy_Zero

Project Link: https://github.com/PappyZero/schooltry-edtech

🙏 Acknowledgments

About

A simple learning assistant that helps students ask questions about lessons — and uses AI to answer them.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages