Skip to content
atharvb13
UniSkill
Public

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Latest commit

 

History

52 Commits

Folders and files

Repository files navigation

UniSkill - Skill-sharing and interest-matching platform

Students within any university possess a wide range of valuable skills, from programming and design to music and sports, but there is currently no centralized platform that allows them to easily share these skills or connect with peers who want to learn them. As a result, opportunities for peer-to-peer learning and collaboration are often missed or limited to small social circles. UniSkill addresses this problem by providing a structured platform where students can discover others with complementary skills and interests. Users register with their university email and create profiles that highlight the skills they can teach and the skills they wish to learn, along with proficiency levels. The system includes a searchable skill directory with keyword matching, autocomplete, and personalized recommendations to help users quickly find relevant peers.

The primary users of UniSkill are students from the Five College community (it would primarily be implemented for students of UMass Amherst initially) who act as both learners and mentors within the platform. Other stakeholders include the broader university community that benefits from knowledge exchange, potential faculty or administrators who may support or oversee the platform, and the developers responsible for building and maintaining the system. The main objective of UniSkill is to create a trusted, campus-specific ecosystem that facilitates skill discovery, peer learning, and collaborative growth. By enabling students to send learning requests, track active collaborations through a dashboard, and communicate through an integrated chat system once a request is accepted, the platform encourages meaningful engagement and practical skill development. This system is needed to bridge the gap between students who want to learn new skills and those willing to share their expertise, thereby strengthening collaboration and knowledge sharing across the Five College community.

Project Overview

UniSkill allows students to sign up with their UMass email, build a skill profile, and discover peers who can teach what they want to learn. The platform is built with a React frontend, a FastAPI backend, and a PostgreSQL database managed through Supabase.

Evaluation report: see EVALUATION.md.

Tech Stack

  • Frontend: React, Tailwind CSS, Framer Motion, Vite
  • Backend: FastAPI (Python)
  • Database: PostgreSQL via Supabase
  • Authentication: Supabase Auth (JWT based)

Features Implemented

Authentication

  • User registration restricted to @umass.edu email addresses
  • Login via UMass email or username
  • Google/Supabase auth callback support
  • JWT based session management
  • Email confirmation flow with configurable auto confirm for development
  • bcrypt password hashing stored alongside Supabase Auth credentials
  • Client side and server side validation for all auth inputs

User Profile

  • Fetch and update profile information including first name, last name, bio, program, degree type, profile image, and external links
  • Public profile endpoint accessible by username
  • Public profile page for viewing another user's profile, skills, reviews, and work samples
  • Profile data persisted in the public.users table linked to Supabase Auth

Skill Management

  • Add skills a user wants to learn, with a target proficiency level
  • Add skills a user can teach, with a current proficiency level
  • Edit proficiency levels for both learning and teaching skills
  • Remove skills from a profile
  • Skills are created in a shared catalogue on first use and reused across users
  • Skill names are normalized to title case to avoid duplicates

Discovery and Recommendations

  • Discover other users and their teach/learn skills
  • Search users by username, first name, last name, and skill name
  • Personalized recommendation endpoint for mutual skill exchanges and one way learning matches

Onboarding

  • Three step onboarding modal shown to new users on first login
  • Step 1: skills to learn with goal proficiency level
  • Step 2: skills to teach with current proficiency level
  • Step 3: optional bio
  • Validates for duplicate entries and prevents the same skill appearing in both learn and teach lists

Dashboard

  • Displays profile card with name, username, and email
  • Editable name and bio fields with save functionality
  • Two skill panels showing learning goals and teachable skills
  • Add, edit, and delete modals for managing skills post onboarding
  • Home, schedule, and chat tabs
  • Rerun setup option to reset and redo the onboarding flow

Collaboration

  • Connection request flow with pending, sent, accepted, and rejected states
  • Meeting scheduler for collaboration sessions
  • Chat previews, message history, sending messages, and read status
  • End to end encryption key endpoints for chat support

Reviews and Portfolio

  • Teaching review submission and deletion
  • Review display on public profiles
  • Work sample upload, viewing, and deletion for user skills
  • Optional portfolio, GitHub, and LinkedIn profile links

Project Structure

uniskill/
├── uniskill-backend/
│   ├── app/
│   │   ├── main.py               # App entry point, router registration, CORS
│   │   ├── supabase_clients.py   # Supabase admin and auth client setup
│   │   ├── routes/
│   │   │   ├── auth.py           # Register and login endpoints
│   │   │   ├── connections.py    # Connection request endpoints
│   │   │   ├── keys.py           # E2E public key endpoints
│   │   │   ├── meetings.py       # Scheduler endpoints
│   │   │   ├── messages.py       # Chat endpoints
│   │   │   ├── profile.py        # Profile, search, recommendations
│   │   │   ├── reviews.py        # Teaching review endpoints
│   │   │   ├── skills.py         # Skill catalogue and user skill endpoints
│   │   │   └── work_samples.py   # Portfolio work sample endpoints
│   │   └── utils/
│   │       ├── validation.py     # Email, username, and password validation
│   │       └── auth_env.py       # Auto confirm email environment flag
│   ├── test/                     # Pytest, integration, and load tests
│   ├── supabase-schema.sql       # Base database schema
│   ├── chat-schema.sql           # Chat tables
│   ├── supabase-meetings.sql     # Meeting scheduler table
│   ├── work-samples-schema.sql   # Work sample table
│   ├── e2e-keys-schema.sql       # Chat key table
│   └── requirements.txt
│
└── uniskill-frontend/
    ├── src/
    │   ├── App.jsx                        # Route definitions
    │   ├── pages/
    │   │   ├── LoginPage.jsx              # Login UI
    │   │   ├── RegisterPage.jsx           # Registration UI
    │   │   ├── DashboardPage.jsx          # Main dashboard
    │   │   ├── UserProfilePage.jsx        # Public user profile page
    │   │   ├── AuthCallbackPage.jsx       # Supabase OAuth callback
    │   │   └── EmailConfirmedPage.jsx     # Post email confirmation landing
    │   ├── components/
    │   │   ├── AuthLayout.jsx             # Shared shell for auth pages
    │   │   ├── FormField.jsx              # Reusable input with icon and error
    │   │   ├── PasswordStrength.jsx       # Live password strength indicator
    │   │   ├── ProtectedRoute.jsx         # Auth guard for protected pages
    │   │   ├── ProfileOnboardingModal.jsx # First login setup wizard
    │   │   └── dashboard/
    │   │       ├── DashboardBody.jsx      # Profile and skill management UI
    │   │       ├── HomeTab.jsx            # Discovery and recommendations
    │   │       ├── ScheduleTab.jsx        # Meetings UI
    │   │       ├── ChatTab.jsx            # Chat UI
    │   │       └── skillConstants.js      # Proficiency level options
    │   └── utils/
    │       ├── api.js             # All backend HTTP calls
    │       ├── e2eEncryption.js   # Browser crypto helpers for chat
    │       ├── session.js         # Token storage and session helpers
    │       ├── validation.js      # Client side form validation
    │       ├── onboardingLocal.js # Local onboarding state helpers
    │       └── videoCompressor.js # Work sample media helper
    └── package.json

Database Schema

public.users

Stores user profile information linked to Supabase Auth.

Column Type Notes
id uuid Primary key, references auth.users
username text Unique
first_name text
last_name text
bio text
contact_email text UMass email
profile_picture_url text
linkedin_url text
github_url text
portfolio_url text
program text
degree_type text
date_of_joining date
password_hash text bcrypt hash
created_at timestamptz
updated_at timestamptz

public.skills

Global catalogue of all skills across the platform.

Column Type Notes
id uuid Primary key
name text Title cased, normalized
category text Optional
created_at timestamptz

public.user_skills

Junction table linking users to skills with flags and proficiency.

Column Type Notes
id uuid Primary key
user_id uuid References public.users
skill_id uuid References public.skills
proficiency_level text beginner, intermediate, advanced, expert
can_teach boolean
wants_to_learn boolean
created_at timestamptz

Unique constraint on (user_id, skill_id).

Additional tables are created by the companion SQL files:

  • supabase-meetings.sql for scheduled collaboration sessions
  • chat-schema.sql and chat-attachments-schema.sql for chat data
  • supabase-teacher-reviews.sql or supabase-teacher-reviews-session-verified.sql for reviews
  • work-samples-schema.sql for portfolio work samples
  • e2e-keys-schema.sql for encrypted chat key lookup

API Endpoints

Health

Method Path Description
GET /health Returns { "status": "ok" }

Auth

Method Path Description
POST /api/auth/register Register a new user
POST /api/auth/login Login with email or username
POST /api/auth/google Login/register from Supabase OAuth user data

Register body:

{
  "firstName": "Jane",
  "lastName": "Doe",
  "username": "janedoe",
  "email": "jane@umass.edu",
  "password": "StrongPass1"
}

Login body:

{ "identifier": "jane@umass.edu", "password": "StrongPass1" }

or

{ "identifier": "janedoe", "password": "StrongPass1" }

Profile

Method Path Auth Description
GET /api/profile/me Required Get logged in user profile
PATCH /api/profile/me Required Update profile fields
GET /api/profile/discover Required List other users and their skills
GET /api/profile/search Required Search users by name, username, or skill
GET /api/profile/recommendations Required Get personalized skill recommendations
GET /api/profile/{username} None Get public profile by username

Skills

Method Path Auth Description
GET /api/skills None List all skills in catalogue
GET /api/skills/me Required Get logged in user's skills
POST /api/skills/me Required Add a skill to user profile
PATCH /api/skills/me/{skill_id} Required Update a user skill
DELETE /api/skills/me/{skill_id} Required Remove a skill from profile

Connections

Method Path Auth Description
POST /api/connections/request Required Send a connection request
GET /api/connections Required List accepted connections
GET /api/connections/pending Required List received pending requests
GET /api/connections/sent Required List sent requests
POST /api/connections/{connection_id}/accept Required Accept a request
POST /api/connections/{connection_id}/reject Required Reject a request
GET /api/connections/status/{target_user_id} Required Get connection status

Messages

Method Path Auth Description
GET /api/messages/previews Required List chat previews
GET /api/messages/{other_user_id} Required Get chat history
POST /api/messages/{other_user_id} Required Send a message
PATCH /api/messages/{other_user_id}/read Required Mark messages as read

Meetings

Method Path Auth Description
GET /api/meetings Required List meetings
POST /api/meetings Required Create a meeting
DELETE /api/meetings/{meeting_id} Required Delete a meeting

Reviews, Work Samples, and Keys

Method Path Auth Description
POST /api/reviews Required Submit or update a teaching review
DELETE /api/reviews/{review_id} Required Delete a review
POST /api/work-samples Required Add a work sample
GET /api/work-samples/{user_skill_id} Required List work samples for a skill
DELETE /api/work-samples/{sample_id} Required Delete a work sample
POST /api/keys/me Required Save current user's public chat key
GET /api/keys/{target_user_id} Required Get another user's public chat key

Setup and Running Locally

Backend

  1. Navigate to the backend directory:
cd uniskill-backend
  1. Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate        # macOS and Linux
.venv\Scripts\activate           # Windows
  1. Install dependencies:
pip install -r requirements.txt
  1. Copy the example env file and fill in your Supabase credentials:
cp .env.example .env
  1. Run the database schema in your Supabase SQL Editor:
supabase-schema.sql

Run the additional SQL files for optional collaboration features:

supabase-meetings.sql
chat-schema.sql
chat-attachments-schema.sql
supabase-teacher-reviews-session-verified.sql
work-samples-schema.sql
e2e-keys-schema.sql
  1. Start the server:
uvicorn app.main:app --reload --port 4000

Frontend

  1. Navigate to the frontend directory:
cd uniskill-frontend
  1. Install dependencies:
npm install
  1. Copy the example env file and fill in your values:
cp .env.example .env
  1. Start the development server:
npm run dev

Environment Variables

Backend (uniskill-backend/.env)

Variable Description
SUPABASE_URL Your Supabase project URL
SUPABASE_ANON_KEY Supabase anon public key
SUPABASE_SERVICE_ROLE_KEY Supabase service role key
FRONTEND_ORIGIN Frontend URL for email redirect (default: http://localhost:5173)
AUTO_CONFIRM_EMAIL Set to true to skip email confirmation in development

Frontend (uniskill-frontend/.env)

Variable Description
VITE_API_BASE_URL Backend URL (default: http://localhost:4000)
VITE_SUPABASE_URL Your Supabase project URL
VITE_SUPABASE_ANON_KEY Supabase anon public key

Common Issues

"Invalid login credentials" with the correct password This usually means the user's email has not been confirmed. Go to Supabase dashboard, Authentication, Users, and confirm the user manually. Alternatively set AUTO_CONFIRM_EMAIL=true in the backend .env for local development.

Dashboard shows "API unreachable" Make sure the FastAPI server is running on port 4000 and that VITE_API_BASE_URL in the frontend .env points to the correct address. Restart npm run dev after changing env values.

public.users is empty after registration The API upserts into public.users after Supabase Auth signup using the service role key. Check that SUPABASE_SERVICE_ROLE_KEY is set correctly and that the table name is exactly users in the public schema.

Testing and Coverage

Backend

Run tests from uniskill-backend:

./.venv/bin/python -m pytest -q

Run backend coverage:

./.venv/bin/python -m pytest --cov=app --cov-report=term -q

Current configured backend coverage: 98% with 27/27 tests passing.

Frontend

Run tests from uniskill-frontend:

npm run test

Run frontend coverage:

npm run test:coverage

Current configured frontend coverage: 93.8% with 19/19 tests passing.

Integration and Load Tests

Run the backend server first, then from uniskill-backend:

./.venv/bin/python test/integration_smoke.py --base-url http://127.0.0.1:4000

Load test example:

./.venv/bin/python test/load_test_health.py --url http://127.0.0.1:4000/health --requests 1000 --concurrency 100

Latest load test result: 1000/1000 successful requests, about 2078 requests/sec, with p95 latency about 48.43 ms.

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages