Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aditya1404sal/socratic.ai
https://github.com/aditya1404sal/socratic.ai
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aditya1404sal/socratic.ai
- Owner: Aditya1404Sal
- Created: 2024-09-21T17:08:44.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-06T19:21:23.000Z (about 2 months ago)
- Last Synced: 2024-11-06T20:27:42.405Z (about 2 months ago)
- Language: JavaScript
- Size: 194 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Socratic AI Tutor
## Overview
Socratic AI Tutor is an innovative educational chatbot powered by Google's Gemini AI and built with Next.js. This project aims to create an intelligent tutoring system that employs the Socratic method to guide students through their learning journey. By asking thought-provoking questions and encouraging critical thinking, the AI tutor helps students discover answers on their own, fostering a deeper understanding of various subjects.
## Features
- **Next.js Framework**: Built on the powerful and flexible Next.js React framework for optimal performance and SEO.
- **Gemini AI Integration**: Leverages the advanced language understanding and generation capabilities of Google's Gemini AI.
- **Socratic Method**: Implements the Socratic questioning technique to stimulate critical thinking and self-directed learning.
- **Adaptive Learning**: Tailors the difficulty and depth of questions based on the student's responses and progress.
- **Multi-subject Support**: Capable of tutoring across a wide range of academic subjects.
- **Interactive Conversations**: Engages students in dynamic, text-based dialogues that mimic real-world tutoring sessions.
## Prerequisites
- Node.js (version 12.0 or higher)
- npm (usually comes with Node.js)
## Installation
1. Clone the repository:
```
git clone https://github.com/yourusername/socratic.ai.git
```
2. Navigate to the project directory:
```
cd fend
```
3. Install dependencies:
```
npm install
```
## Configuration
1. Obtain API credentials from the Google AI Studio.
2. Create a `.env.local` file in the project root and add your API key:
```
GEMINI_API_KEY=your_api_key_here
```
## Development
Run the development server:
```
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Production Build
To create a production build:
```
npm run build
```
Then start the production server:
```
npm start
```
## Usage
After starting the development or production server, navigate to the application in your web browser. Follow the on-screen prompts to begin your tutoring session.
## Contributing
We welcome contributions to the Socratic AI Tutor project! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to submit pull requests, report issues, and suggest improvements.
his project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or support, please open an issue in the GitHub repository or contact the project maintainer at [[email protected]](mailto:[email protected]).