https://github.com/irere123/mentor.ai
AI-Powered Code Mentor for all your codebase
https://github.com/irere123/mentor.ai
aisdk nextjs typescript
Last synced: 29 days ago
JSON representation
AI-Powered Code Mentor for all your codebase
- Host: GitHub
- URL: https://github.com/irere123/mentor.ai
- Owner: Irere123
- Created: 2025-02-05T11:16:57.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-02-05T11:45:25.000Z (3 months ago)
- Last Synced: 2025-02-05T12:35:30.296Z (3 months ago)
- Topics: aisdk, nextjs, typescript
- Language: TypeScript
- Homepage:
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MentorAI
MentorAI is an AI-powered web application that empowers developers to explore and understand GitHub codebases efficiently. By providing one or more GitHub repository links, users can interact with an AI assistant that retrieves insights, explains code structures, and answers questions in real-time.
## Get started!
### Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/) (latest LTS recommended)
- [Git](https://git-scm.com/)
- A GitHub account (for authentication)
### Setup
```sh
# Clone the repository
git clone https://github.com/irere123/mentorai.git
cd mentorai
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env and configure required API keys and settings
# Run the development server
pnpm run dev
```
🔹 Open your browser and navigate to `http://localhost:3000`
## Contributing
We welcome contributions from the community! To get started:
1. **Fork** the repository.
2. **Clone** your fork:
```sh
git clone https://github.com/irere123/mentorai.git
```
3. **Create a feature branch:**
```sh
git checkout -b feature-branch
```
4. **Commit your changes:**
```sh
git commit -m 'Add new feature'
```
5. **Push to your branch:**
```sh
git push origin feature-branch
```
6. **Open a Pull Request** with a detailed description of your changes.
📖 Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
## 📬 Contact
For inquiries, issues, or feedback, reach out via:
- Twitter/X: [@irere_emmanuel](https://x.com/irere_emmanuel)
- GitHub Issues: [Open an issue](https://github.com/irere123/mentorai/issues)
---