Skip to content

Open HR helps your startup to handle important things like employees, payroll, assets etc

License

Notifications You must be signed in to change notification settings

zeon-studio/open-hr

Repository files navigation

Open HR Solution

A comprehensive ERP solution to streamline user management, leave, payroll, asset management, and more.

Made with β™₯ by Zeon Studio

If you find this project useful, please give it a ⭐ to show your support.

CleanShot 2025-02-18 at 09 57 27

πŸ“Œ Key Features

  • πŸ‘₯ User Management with detailed information
  • πŸ‘₯ Onboarding Steps for New Employees
  • 🎯 Different Dashboards for Admin, Moderator and User
  • πŸ” Search Functionality on every page
  • 🏷️ Payroll Management with salary, bonus, and extra pay
  • πŸ”— Tools and 3rd-party Account management
  • πŸ“š Online Course Management
  • πŸ“± Asset Management
  • πŸ–οΈ Leave Management
  • πŸ“† Holiday and Event Calendar
  • βš™οΈ Settings to manage every module and app configuration

πŸ“¦ Tech Stack


πŸš€ Getting Started With Development

To get a local copy up and running, please follow these simple steps.

βš™οΈ Prerequisites

To start using this project, you need to have some prerequisites installed on your machine.

Third-Party Services

πŸ‘‰ Project Setup Locally (Frontend)

  1. Clone frontend repo
git clone https://github.com/zeon-studio/open-hr.git
  1. Go to the project folder
cd open-hr
  1. Install packages with yarn
yarn
  1. Set up your .env file
  • Duplicate .env.example to .env
  • Fullfil every env field
  • Create a Google Cloud Client ID for the Web application for Gmail authentication.
  1. Quick start with Yarn
yarn dev

πŸ‘‰ Project Setup Locally (Backend)

  1. Clone backend repo
git clone https://github.com/zeon-studio/open-hr-backend.git
  1. Go to the project folder
cd open-hr-backend
  1. Install packages with yarn
yarn
  1. Set up your .env file
  • Duplicate .env.example to .env
  • Fullfil every env field
  1. Quick start with Yarn
yarn start

πŸš€ Build

After you finish your development, you can build or deploy your project. Let's see the process:

πŸ‘‰ Build Command

You can use the following command to build your project locally (Frontend and Backend). It will purge all the unused CSS and minify all the files.

yarn build

πŸš€ Deploy

If your project built successfully on local, you can deploy it to vercel, render, or any other hosting platform.

πŸ‘‰ Deploy Backend to Vercel

To deploy the backend to Vercel, you can use the vercel.json configuration file. Simply overwrite the build command to yarn build on the Vercel platform and don't forget to add the environment variables to Vercel. This will ensure that the backend is built and deployed correctly.

πŸ‘‰ Deploy Frontend to Vercel

To deploy the frontend to Vercel, Simply overwrite the build command to yarn build on the Vercel platform and don't forget to add the environment variables to Vercel. This will ensure that the backend is built and deployed correctly.

πŸ‘‰ Upload Sample Data

After deploying the backend, you can upload sample data to the database using Mongodb Compass. Follow these steps:

  1. Open Mongodb Compass and connect to your MongoDB database.
  2. Navigate to the open-hr database.
  3. Upload example-data/employee.json to the employees collection. [make sure you have changed the work_email to your email address, so that you can login with it]
  4. Upload example-data/settings.json to the settings collection.

πŸ‘‰ Login To Dashboard

After uploading the sample data, you can login to the dashboard using the email address that you used in the example-data/employee.json file. Just click on the login with Google button and you will be redirected to the dashboard.


πŸ”’ Guide to Staying Compliant

🐞 Reporting Issues

We use GitHub Issues as the official bug tracker for this Template. Please Search existing issues. It’s possible someone has already reported the same problem. If your problem or idea has not been addressed yet, feel free to open a new issue.

πŸ“ License

Copyright (c) 2025 - Present, Designed & Developed by Zeon Studio

Code License: Released under the MIT license.


πŸ’» Need Help To Setup Or Customization?

If you need to set up the application, app customization, or complete application development services from scratch you can Hire Us.

About

Open HR helps your startup to handle important things like employees, payroll, assets etc

Resources

License

Stars

Watchers

Forks

Languages