HireGo is a scalable, production-ready REST API for a modern job portal. Built with Node.js, Express, TypeScript, and PostgreSQL, it supports robust role-based workflows for Candidates, Hiring Managers, and Admins.

• Backend: Node.js, Express.js, TypeScript
• Database: PostgreSQL + Prisma ORM
• Authentication: JWT (JSON Web Tokens)
• Validation: Zod
• File Uploads: Multer (PDF resume handling)
• Testing: Jest & Supertest
• Docs: Swagger/OpenAPI
• DevOps: Docker, Docker Compose, GitHub Actions (with DockerHub integration)

• 🔐 Secure JWT-based authentication
• 🛡️ Role-Based Access Control (RBAC)
• 📄 Resume uploads with PDF validation
• ⭐ Favorite jobs support
• 🔍 Filtering, sorting & pagination on jobs
• 🗂️ Modular MVC structure
• 🧪 Automated testing (Jest + Supertest)
• 📦 Dockerized for easy deployment
• 🚀 GitHub Actions CI/CD with DockerHub integration
• 📜 Swagger API documentation

src/
├── controllers/         # Business logic
├── routes/              # Express routes
├── services/            # Service layer
├── middlewares/         # Auth, error handling, etc.
├── validators/          # Zod schemas and request validation
├── utils/               # Helper functions and utilities
├── types/               # TypeScript type definitions and interfaces
├── docs/                # Swagger/OpenAPI documentation and specs
├── lib/                 # Prisma client
├── app.ts               # Express config
└── server.ts            # Entrypoint

• Node.js ≥ 18
• PostgreSQL
• Docker & Docker Compose (optional, for easy setup)
• .env file configured (see below)

git clone https://github.com/your-username/hirego-api.git
cd hirego-api
npm install

Create a .env file in the root:

DATABASE_URL="postgresql://<user>:<password>@localhost:5432/hirego"
JWT_SECRET="your_secret_here"

For Docker Compose, use:

DATABASE_URL="postgresql://<user>:<password>@db:5432/hirego"
JWT_SECRET="your_secret_here"

(Replace <user> and <password> with your actual DB credentials.)

npx prisma migrate dev --name init
npx prisma generate

npm run dev
# Server starts at: http://localhost:5000

docker compose up --build
# Or to remove old volumes/data:
docker compose down -v && docker compose up --build

All endpoints return JSON.
For full interactive docs, see /api-docs (Swagger UI) when the server is running.

GET /getalls?page=1&limit=10&sortBy=createdAt&order=desc&jobType=Full-Time&location=NYC&companyName=Acme

npm run test

Runs unit & integration tests using Jest & Supertest.

docker build -t hirego-api .
docker run -p 5000:5000 --env-file .env hirego-api

docker compose up --build

• Lint, test, and build Docker image on every push to main
• Automatic Docker image push to DockerHub (DOCKERHUB_USERNAME / DOCKERHUB_TOKEN secrets required)
• See .github/workflows/ci-cd.yml for the full pipeline

To set up DockerHub deployment:

1. Create an access token on DockerHub
2. Add DOCKERHUB_USERNAME and DOCKERHUB_TOKEN as GitHub repository secrets
3. Push to main and your image will be built & published!

MIT

• Asmare – Developer

Coming soon...
Or see Swagger API docs if deployed.

Tip: PRs and contributions are welcome!