Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ac-i2i-engineering/matching-engine
This is the matching engine we are building to match students with each other & ideas!
https://github.com/ac-i2i-engineering/matching-engine
artificial-intelligence django-application django-framework edtech-software machine-learning python3
Last synced: 23 days ago
JSON representation
This is the matching engine we are building to match students with each other & ideas!
- Host: GitHub
- URL: https://github.com/ac-i2i-engineering/matching-engine
- Owner: ac-i2i-engineering
- License: mit
- Created: 2024-08-26T19:44:59.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T19:37:49.000Z (about 1 month ago)
- Last Synced: 2024-10-17T02:02:57.044Z (29 days ago)
- Topics: artificial-intelligence, django-application, django-framework, edtech-software, machine-learning, python3
- Language: Python
- Homepage: https://matching-engine-p7v6.onrender.com
- Size: 122 KB
- Stars: 0
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Matching Engine
This is the matching engine we are building to match students with each other & ideas!
To clone the app, run in terminal:
```bash
git clone https://github.com/ac-i2i-engineering/matching-engine.git
cd matching-engine
```
Set-up a virtual environment and activate it to "containerize" the dependencies:
```bash
python3 -m venv env
source env/bin/activate
```
To run the app locally, run:
```bash
pip install -r requirements.txt
cd matching_backend
python manage.py makemigrations
python manage.py migrate
python manage.py runserver
```
# System Architecture
```mermaid
graph TD
A[Upload CSV File] -->|CSV File| B[clean_and_create_users]
B --> J[standardize and create_user_profiles]
J --> |CSV FileUserProfile Instances Created| L[form_teams]
L --> M[calculate_final_scores from user_profiles]
M --> N[calculate_cosine_similarity from user_profiles]
M --> O[calculate_interests_goals_scores from user_profiles]
L --> P[Form Initial Teams based on roles]
P --> Q[Match Best Engineer and Finance based on scores]
Q --> R[Handle Leftover Users & Create Final Teams]
R --> |Team Data| U[Render Teams in HTML]
```
# CI/CD Testing & Deployment Pipeline
We use modularized `pytest-django`-based unit-tests and `GitHub Actions` to test our backend ("business") logic in an end-to-end CI/CD environment. We also run custom regression-tests and deployment/integration-tests through a combination of technologies like [Railway](https://railway.app/), [Vercel](https://vercel.com/) & `npm`. This is to have health-checks on the system & give our developers extensive experience in technologies that they most-likely will encounter in industry settings.
# Demo & screenshots: (Last updated 10th Sept, 2024)
- **Youtube Demo link:** https://youtu.be/oAPVXGaYS8Q
