https://github.com/imshibaji/jobs-api-server
This is the Jobs API Server by Shibaji Debnath.
https://github.com/imshibaji/jobs-api-server
api-server backend backend-api backend-services content-management-system jobs-api jobsearch jobsystem open-source server
Last synced: 4 months ago
JSON representation
This is the Jobs API Server by Shibaji Debnath.
- Host: GitHub
- URL: https://github.com/imshibaji/jobs-api-server
- Owner: imshibaji
- License: mit
- Created: 2025-11-18T18:17:47.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T19:24:26.000Z (6 months ago)
- Last Synced: 2026-01-11T05:48:28.150Z (6 months ago)
- Topics: api-server, backend, backend-api, backend-services, content-management-system, jobs-api, jobsearch, jobsystem, open-source, server
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Docker.md
- License: LICENSE
Awesome Lists containing this project
README
# Jobs Portal API Server Application
This is the Fullstack Jobs Portal Applications APIs. If you wanted to launch your own Jobs Portal then you can use this for your application backend. It is An Open Source Project.
## Description
[Jobs Portal API](https://github.com/imshibaji/jobs-api-server) is based on a [NestJS](https://github.com/nestjs/nest) framework TypeScript starter repository. It is an open source project that anyone can use to launch their own Jobs Portal. Here you can find all the resources you need to get started with the project.
## Environment Variables
To run this project, you will need to create a `.env` file and add the following environment variables:
```bash
APP_NAME="Jobs API Server"
APP_VERSION="1.0.0"
APP_ENVIRONMENT=development
APP_PORT=3300
APP_SECRET_KEY=
DB_TYPE=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USER=root
DB_PASS=password
DB_NAME=jobs_api_server
DB_SYNC=true
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_USER=default
REDIS_PASS=password
REDIS_DB=1234
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587 # or 465
SMTP_USER=admin@gmail.com
SMTP_PASS=password
SMTP_SECURITY=TLS # or SSL
WHATSAPP_NUMBER=
SMS_NUMBER=
```
## Deployment Process with Docker
If you wanted to Quickly deploy this Project on Docker then you can follow these steps:
create a `docker-compose.yml` file in the root directory of the project.
then copy the following content into the file:
```yaml
server:
image: imshibaji/jobs-api-server:latest
container_name: jobs-server
restart: unless-stopped
env_file:
- .env
environment:
NODE_ENV: production
ports:
- 3300:3300
volumes:
- ./uploads:/app/uploads:rw
depends_on:
db:
condition: service_healthy
redis:
condition: service_healthy
db:
image: postgres:17
restart: always
user: postgres
volumes:
- db_data:/var/lib/postgresql/data
environment:
- POSTGRES_DB=jobs_api_server
- POSTGRES_PASSWORD=Spaceranger@123
ports:
- 5433:5432
healthcheck:
test: [ "CMD", "pg_isready" ]
interval: 10s
timeout: 5s
retries: 5
redis:
image: redis:latest
restart: always
ports:
- 6378:6379
volumes:
- redis_data:/data
healthcheck:
test: [ "CMD", "redis-cli", "ping" ]
interval: 10s
timeout: 5s
retries: 5
environment:
- REDIS_PASSWORD=Spaceranger@123
volumes:
server_app:
driver: local
db_data:
redis_data:
networks:
proxy:
external:
name: proxy
```
then run the following command:
1. copy .env.example file to .env file
2. Then run `docker compose up -d` command
3. Then run `docker compose logs -f` command
4. Then open `http://localhost:3300` in your browser
5. Check Project Status with `docker compose ps` command
## For upgrading the project
1. Run `docker compose down` command for stopping the project
2. Run `docker compose pull` command for updating the project
3. Run `docker compose up -d` command for starting the project
Use this Process to deploy this Project on Docker Easily.
You can also modify the `Dockerfile` to fit your needs.
But if you wanted to more control then you can modify the `docker-compose.yaml` file.
## How to use
1. Register a new user
2. Then login to your account
3. Get Access Token and Set Authorization Header
4. Then you can use the API endpoints
## API Endpoints
```bash
# Register a new user
POST /auth/register
# Login a user
POST /auth/login
# Get all jobs
GET /jobs
# Get a single job
GET /jobs/:id
# Create a new job
POST /jobs
# Update a job
PUT /jobs/:id
# Delete a job
DELETE /jobs/:id
# Many more API endpoints are available in the project source code
```
## Hosting on VPS
You can deploy your Project on VPS with [Hostinger](https://www.hostinger.in/cart?product=vps%3Avps_kvm_2&period=12&referral_type=cart_link&REFERRALCODE=SHIBAJIDEBNATH&referral_id=019b06a2-98e8-7397-8bd6-f7b0e0cb1dc6). It a very cost-effective and easy-to-use platform for deploying NestJS applications on Hostinger.
If want to get offer then you can use [Hostinger Offer](https://www.hostinger.in/cart?product=vps%3Avps_kvm_2&period=12&referral_type=cart_link&REFERRALCODE=SHIBAJIDEBNATH&referral_id=019b06a2-98e8-7397-8bd6-f7b0e0cb1dc6) for your project from this link.
## Setup Jobs API Server on VPS
1. Create a VPS on [Hostinger](https://www.hostinger.in/cart?product=vps%3Avps_kvm_2&period=12&referral_type=cart_link&REFERRALCODE=SHIBAJIDEBNATH&referral_id=019b06a2-98e8-7397-8bd6-f7b0e0cb1dc6)
2. Choose your plan and click on checkout
3. Enter your details and click on checkout
4. Setup your VPS with Docker
5. Then Follow this Process to [Setup Jobs API Server](#deployment-process-with-docker) on Docker Easily
## Deployment with Docker
You can deploy This Project on Docker with [Docker](https://www.docker.com/). It a very cost-effective and easy-to-use platform for deploying NestJS applications on Docker.
## Resources
You wanted to Modify and Contribute to this Project then you can find all the resources you need to get started with the project:
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- Visit the [Docker documentation](https://docs.docker.com) to learn more about Docker.
- For deployment, you can use [Docker Compose](https://docs.docker.com/compose/).
## Stay in touch
If you have any questions or feedback about this project.
Also you need any setup help, please don't hesitate to reach out to me.
- Author - [Shibaji Debnath](https://shibajidebnath.com)
- Project - [Jobs API Server](https://github.com/imshibaji/jobs-api-server)
- LinkedIn - [LinkedIn](https://www.linkedin.com/in/shibaji/)
## License
Jobs API Server is [MIT licensed](https://github.com/imshibaji/jobs-api-server/blob/main/LICENSE).
