Skip to content

isaactapara/skillsync-compass

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SkillSync AI

SkillSync AI is a Gemini-powered Career Intelligence Copilot designed to analyze user CVs and skill profiles against curated Kenyan job market data. The system identifies skill gaps and generates highly structured, personalized career roadmaps.

Architecture

This repository is structured as a monorepo containing two primary services:

  1. Frontend (skillsync-compass): A React SPA built with Vite, Tailwind CSS, and shadcn/ui.
  2. Backend (server): A Node.js/Express REST API responsible for handling Google Gemini API integration and enforcing structured JSON schema outputs.

Prerequisites

  • Node.js (v18 or higher recommended)
  • npm (v9 or higher recommended)
  • A Google Gemini API Key

Local Development Setup

1. Backend Service

Navigate to the server directory and install dependencies:

cd server
npm install

Configure the environment variables:

cp .env.example .env

Ensure the .env file contains your valid GEMINI_API_KEY and sets the PORT (default is 5000).

Start the backend development server:

npm start

2. Frontend Interface

Open a new terminal session, navigate to the frontend directory, and install dependencies:

cd skillsync-compass
npm install

Start the Vite development server:

npm run dev

The application will be accessible at http://localhost:8080.

Production Deployment

Building the Frontend

The React frontend must be compiled into static assets prior to deployment. Navigate to the frontend directory and execute the build command:

cd skillsync-compass
npm run build

This command generates a dist folder containing the optimized static files. These files can be served using any static web host, such as Nginx, AWS S3, Vercel, or Netlify.

Running the Backend in Production

For the Node.js backend, ensure NODE_ENV=production is set in your environment variables. It is highly recommended to use a process manager such as PM2 to monitor the server:

cd server
npm install -g pm2
pm2 start server.js --name "skillsync-api"

Environment Synchronization

Ensure that the production frontend correctly points its API requests to your deployed backend URL. By default, the frontend is configured to target http://localhost:5000/api/analyze. In production, this URL should be updated or proxied appropriately depending on your infrastructure configuration.

License

This project is proprietary.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors