Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-d-roshan/brainy-1
AI Homework Solver
https://github.com/d-d-roshan/brainy-1
clerk convex nextjs shadcn-ui togetherai
Last synced: 21 days ago
JSON representation
AI Homework Solver
- Host: GitHub
- URL: https://github.com/d-d-roshan/brainy-1
- Owner: D-D-Roshan
- Created: 2024-08-09T08:18:44.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-09T10:19:16.000Z (5 months ago)
- Last Synced: 2024-11-13T18:44:43.977Z (about 1 month ago)
- Topics: clerk, convex, nextjs, shadcn-ui, togetherai
- Language: TypeScript
- Homepage: https://brainy-nine.vercel.app
- Size: 166 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brainy: AI Homework Helper
Brainy is an AI-powered chatbot built to assist students by solving homework problems and providing accurate answers to their questions. It's designed with a focus on user-friendly interaction and real-time problem-solving.
## Features
- **Homework Solver**: Get solutions to your homework problems.
- **Accurate Answers**: Brainy uses advanced AI to deliver precise and reliable responses.
- **User-Friendly Interface**: Built with Shadcn for a clean and intuitive UI.
- **Secure Authentication**: User authentication and management are handled by Clerk.
- **Real-Time Interaction**: Powered by Convex for efficient and real-time data handling.
- **AI-Driven Responses**: Integrated with Together.ai for cutting-edge AI capabilities.
## Technologies Used
- **Next.js**: Framework for building the React application.
- **Clerk**: Authentication and user management.
- **Convex**: Real-time data handling and backend services.
- **Shadcn**: UI components and design system.
- **Together.ai**: AI API for question-solving and answers.
## Installation
To set up the project locally, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/D-D-Roshan/BRAINY.git
cd BRAINY
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
Create a `.env.local` file and add your API keys and configurations:
```plaintext
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your-clerk-publishable-key
CLERK_SECRET_KEY=your-clerk-secret-key
CONVEX_DEPLOYMENT=your-convex-deployment
NEXT_PUBLIC_CONVEX_URL=your-convex-url
TOGETHER_API_KEY=your-together-api-key
```
4. Run the development server:
```bash
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the app in action.
## Usage
1. Register or log in using Clerk authentication.
2. Access the chatbot interface and type in your homework problem or question.
3. Get accurate and detailed solutions or answers instantly.
## Contact
