EduCore AI is a powerful educational assistant built for Sri Lankan Advanced Level (A/L) students studying Combined Mathematics, Physics, Chemistry, or Biology. Powered by cutting-edge AI, it provides instant, syllabus-aligned answers to academic questions — 24/7.
- Students looking for step-by-step answers and concept clarity.
- Teachers & Mass Classes who want to empower their entire class with advanced AI support.
- Institutes seeking to offer modern, digital learning tools to enhance student performance.
- 📚 Real-time Q&A for Combined Maths, Physics, Chemistry & Biology
- 🤖 AI trained with local exam formats and past paper styles
- 🔄 Ask unlimited academic questions, anytime
- 🧪 Clear, exam-focused explanations with step-by-step breakdowns
- 💬 Sinhala and English language support
- 🛠️ Central dashboard to manage all students
- 📊 Student activity reports (questions asked, topics studied)
- 🧑🎓 Bulk account creation for entire classes
- 🧠 Optionally tailor AI response style to your teaching approach
- 🎓 Custom institute/class login page with your branding
EduCore AI is available as:
- A Web App (Desktop & Mobile responsive)
- Soon to be available on Android and iOS
Use any device with a browser and internet connection to:
- Log in
- Ask questions
- View history
- Monitor your learning
EduCore AI is built with a modern, scalable, and AI-first technology stack:
- Frontend:
- Next.js - React framework for server-side rendering and static site generation.
- TypeScript - Superset of JavaScript that adds static typing.
- Tailwind CSS - Utility-first CSS framework for rapid UI development.
- Shadcn/ui - Re-usable UI components built with Radix UI and Tailwind CSS.
- Backend & AI:
- Firebase - Platform for building web and mobile applications (used for Authentication, Database, and Hosting).
- Genkit (Google AI) - Open-source framework for building AI-powered applications.
- Deployment:
- Netlify - Platform for hosting and serverless backend services.
Follow these steps to set up and run the project locally:
-
Clone the repository:
git clone https://github.com/Senath-Sethmika/EduCore-AI.git
-
Navigate to the project directory:
cd EduCore-AI -
Install dependencies:
npm install
-
Set up Environment Variables: Create a
.env.localfile in the root of your project and add your Firebase configuration. You can get these from your Firebase project settings.NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_idNote: These are
NEXT_PUBLIC_variables, which are essential for Next.js to expose them to the browser. Ensure you replaceyour_...placeholders with your actual Firebase project credentials. -
Run the development server:
npm run dev
Open http://localhost:3000 with your browser to see the result.
- Visit the EduCore AI Website
- Sign up as a Student or Teacher
- For institutes, contact us to register your class and onboard your students
- Start learning – ask your academic questions and receive instant answers from our AI assistant
We welcome contributions from the community! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated.
Here's how you can contribute:
-
Reporting Bugs or Suggesting Features:
- If you find a bug or have an idea for a new feature, please open an issue on our GitHub Issues page.
- Provide as much detail as possible, including steps to reproduce for bugs.
-
Coding Standards:
- Try to follow the existing code style and structure.
- Write clean, readable, and maintainable code.
- Ensure your code is well-commented, especially in complex areas.
-
Branch Naming Conventions:
- For new features:
feature/your-feature-name(e.g.,feature/user-profile-page) - For bug fixes:
bugfix/issue-numberorbugfix/short-description(e.g.,bugfix/123orbugfix/login-error) - For documentation changes:
docs/update-readme
- For new features:
-
Pull Request (PR) Process:
- Fork the repository to your own GitHub account.
- Create a new branch from
mainusing the naming conventions above. - Make your changes in your new branch.
- Test your changes thoroughly.
- Push your branch to your forked repository.
- Open a Pull Request (PR) to the
mainbranch of the original repository. - Provide a clear and concise title and description for your PR.
- Reference any relevant issues in your PR description (e.g., "Closes #123").
- Ensure your PR passes any automated checks or tests.
We're excited to see your contributions and build a better EduCore AI together!
Need help or want to onboard your class or institute?
📧 Email: educore.ai.dev@gmail.com
🌐 Website: https://educore-ai.netlify.app/
📱 WhatsApp: +94 762259050
EduCore AI is licensed under a custom license. We grant permission for the following uses (see LICENSE.txt for full details):
- Personal Use: You are free to use, modify, and distribute the code for your own personal projects.
- Educational Use: Students, teachers, and educational institutions are welcome to use and adapt the code for learning and teaching purposes.
- Non-Commercial Use: You may use this project for non-commercial activities, provided that it does not involve direct or indirect financial gain.
Prohibition of Commercial Use: Commercial use, reproduction, distribution, or modification of this project or its derivatives for direct or indirect financial gain is strictly prohibited without explicit prior written permission from Senath Sethmika.
For the complete license terms, please refer to the LICENSE.txt file included in this repository.
Senath Sethmika and the team at Xtream Developers
Passionate about transforming education with technology and empowering future minds in Sri Lanka.
“Let AI be your second teacher. Ask. Learn. Succeed.” 🚀