Open Career Portal

This project provides a robust web-based platform for companies to host their own career pages, allowing users to browse job listings and apply directly from the website.

Table of Contents

• Features
• Getting Started
• Prerequisites
• Installing
  • Set up both the server and the client
  • Running the tests
• Deployment
• Built With
• Contributing
• License
• Acknowledgments

Features

• Job listing with search functionality
• Individual job application pages
• User authentication (Google OAuth, Guest)
• Submitted Applications page
• Responsive design for mobile and desktop
• (RBAC) - Role-based access control (Admin, User, Guest)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

🔴Tools you MUST HAVE to run this app.🔴 Install the software and how to install them:

• Node.js - Node version v22.2.0 - LTS.
• Git - Version 2.42.1
• NPM - npm version 10.7.0
• MongoDB - mongosh version 2.2.6 - Local installtaion
• MongoDB Cloud - MongoDB Atlas register for free account - Optional

What things you need to install the software and how to install them:

git clone https://github.com/IvanoskiHarmonia/open-career-portal.git
cd open-career-portal

Installing

A step by step series of examples that tell you how to get a development env running:

Set up both the server and the client

In the root directory, install dependencies for both the server and the client:

All at once:

npm run install:all

Or separately:

npm install
npm run install:client
npm run install:server

Set up local MongoDB

Local installtaion

Run the application

For testing production and development in general there's 3 ways to start the application:

Production:

npm run prod

User development:

npm run dev:user

Admin development:

npm run dev:admin

Running the tests

Currently, the tests that are on the project do not cover the entire codebase. To run the tests, you can use the following command:

In root directory:

npm run test:client

Deployment

This project is currently deployed on Heroku. The deployment process is done by Project Maintainers.

Built With

• React.js - The web framework used
• Node.js - Server Environment
• Express.js - Web framework for Node.js
• MongoDB - Database

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Starring this repository means a lot to us!