Skip to content

udaysagarm/Hirely

Repository files navigation

Hirely

Hirely is a gig-matching platform designed to connect job seekers with employers for short-term, location-based work. It facilitates the entire process from job posting and discovery to assignment and rating.

Features

  • User Roles: Support for Job Seekers, Employers, and Admins.
  • Job Management: Post, browse, assign, and track status of jobs.
  • Ratings & Reviews: Reputation system for both workers and employers.
  • Real-time Interaction: Job interests and assignments.

Technology Stack

Frontend

  • React: UI Library (v19)
  • Vite: Build tool and development server
  • TailwindCSS: Utility-first CSS framework for styling
  • React Router: Navigation and routing
  • Lucide React: Icon set

Backend

  • Node.js: Runtime environment
  • Express: Web framework for API
  • PostgreSQL: Relational database
  • BCrypt: Password hashing
  • JSON Web Tokens (JWT): Authentication

Prerequisites

Ensure you have the following installed on your machine:

Setup Instructions

1. Database Setup

  1. Ensure PostgreSQL is running.
  2. Create a new database for the project (e.g., hirely_db).
  3. Run the SQL commands found in Database_schema.txt to initialize the tables.

2. Backend Setup

  1. Navigate to the server directory:
    cd server
  2. Install dependencies:
    npm install
  3. Create a .env file in the server directory and configure your environment variables (Database credentials, JWT secret, etc.).
  4. Start the backend server:
    node server.js
    The server typically runs on port 3000 (or as configured).

3. Frontend Setup

  1. Open a new terminal and navigate to the project root:
    cd .. # if you are in the server directory
  2. Install dependencies:
    npm install
  3. Start the development server:
    npm run dev
  4. Open your browser and navigate to the URL shown (usually http://localhost:5173).

Project Structure

  • /src: Frontend React source code.
  • /server: Backend Node/Express API code.
    • server.js: Main entry point for the API.
    • db/: Database connection logic.
    • routes/: API route definitions.
  • Database_schema.txt: SQL schema for database creation.

Deployment Roadmap

We are deploying Hirely to Microsoft Azure using Docker containers.

Phase 1: Containerization (Complete)

  • Create Dockerfile for multi-stage build (Frontend + Backend).
  • Test container locally (docker run).

Phase 2: Azure Infrastructure

  • Create Azure Container Registry (ACR).
  • Push Docker image to ACR.
  • Create Azure App Service (Linux B1 Plan).
  • Configure Environment Variables (DB Connection, JWT Secret) in App Service.

Phase 3: CI/CD

  • Enable Continuous Deployment from ACR.
  • (Optional) Setup GitHub Actions for automated build & push.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages