https://github.com/soham901/pairrogrammer
Pairrogrammer: A Tinder-like app for CS students to match, collaborate, and build projects together
https://github.com/soham901/pairrogrammer
Last synced: 4 months ago
JSON representation
Pairrogrammer: A Tinder-like app for CS students to match, collaborate, and build projects together
- Host: GitHub
- URL: https://github.com/soham901/pairrogrammer
- Owner: soham901
- License: mit
- Created: 2024-12-12T13:25:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T07:05:55.000Z (12 months ago)
- Last Synced: 2025-02-08T07:41:26.591Z (11 months ago)
- Homepage: https://soham901.github.io/pairrogrammer/
- Size: 702 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pairrogrammer: Tinder but for project collaboration
Welcome to the **Pairrogrammer** repository! This project is designed to help computer science students find the perfect collaborators for their projects based on shared skills, interests, and goals. With AI-powered recommendations, skill-based matchmaking, and gamification, **Pairrogrammer** aims to enhance collaboration within the CS community.
## Documentation
The documentation for the project can be found at [docs](https://soham901.github.io/pairrogrammer).
## Project Overview
Pairrogrammer connects students, helps them find ideal project collaborators, and supports skill-based matchmaking to maximize project success. The app is built with a mobile-first approach, leveraging Flutter for the frontend, FastAPI for the backend, and Hono for handling requests and integrating machine learning models.
### Key Features:
- **Skill-based matchmaking**: Find the best collaborators based on your skills and preferences.
- **Project collaboration**: Create and join projects with users who complement your strengths.
- **Gamification**: Earn points, badges, and climb up the leaderboard for contributions.
- **AI-powered recommendations**: Get personalized suggestions for projects and collaborators.
- **Mobile-first design**: A responsive, engaging experience built with Flutter.
## Branches
The project is organized into several branches, each serving a specific purpose:
- **`main`**: Contains the primary documentation and serves as the central reference point for the entire project.
- **`docs`**: Contains all the project documentation (features, tech stack, contribution guidelines, etc.).
- **`mobile`**: Contains the code for the Flutter-based mobile app. This is where all frontend development happens.
- **`backend`**: Contains the code for the backend APIs built with FastAPI and Hono, including the user management, matchmaking logic, and project collaboration features.
- **`ai`**: Contains machine learning models and algorithms that power the skill-based matchmaking and project recommendations.
## Getting Started
To get started with the project, follow the steps below:
### 1. Clone the Repository
```bash
git clone https://github.com/soham901/pairrogrammer.git
```
### 2. Switch to the branch you want to work on
```bash
git checkout
```
### 3. Install Dependencies according to the branch
```bash
flutter pub get # Install Flutter dependencies
pip install -r requirements.txt # Install Python dependencies
npm install # Install JavaScript dependencies
```
### 4. Run the App
```bash
flutter run # Run the Flutter app
fastapi dev # Run the FastAPI server
npm run dev # Run the JavaScript app
```
## Contributing
We welcome contributions to the Pairrogrammer project.
If you have any questions or need further assistance, please don't hesitate to reach out to us at [soham901](https://github.com/soham901).
Thank you again for contributing to Pairrogrammer!