https://github.com/nameissakthi/starhr
StarHR Consultancys Website is Company for Import & Export and Oversea Manpower Agency developed in MERN stack.
https://github.com/nameissakthi/starhr
api axios-react css3 emailjs express-js mongodb mongodb-atlas nodejs reactjs vercel vercel-deployment vite
Last synced: 2 months ago
JSON representation
StarHR Consultancys Website is Company for Import & Export and Oversea Manpower Agency developed in MERN stack.
- Host: GitHub
- URL: https://github.com/nameissakthi/starhr
- Owner: nameissakthi
- License: gpl-3.0
- Created: 2024-10-03T08:50:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-28T12:38:41.000Z (over 1 year ago)
- Last Synced: 2025-06-22T09:38:46.040Z (about 1 year ago)
- Topics: api, axios-react, css3, emailjs, express-js, mongodb, mongodb-atlas, nodejs, reactjs, vercel, vercel-deployment, vite
- Language: JavaScript
- Homepage: https://star-hr.vercel.app
- Size: 4.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Star HR Consultancys
**starHR** is a Human Resource Management System (HRMS) designed to Products Management, enhance employee management, and improve organizational efficiency.
## Features:
- **Add Work Records**: Easily add and manage details about the work and services provided by the company.
- **Service Management**: Track and update services offered by the company with an organized interface.
- **Delete Functionality**: Remove outdated or unnecessary records with a simple delete option.
## Tech Stack:
- **Frontend**: React.js (Vite.js), Redux for state management
- **Backend**: Node.js, Express.js
- **Database**: MongoDB
## **Project Setup**
### **Prerequisites**
- Node.js (v14 or above)
- MongoDB (local or cloud setup)
- npm or yarn
### **Clone the repository:**
```bash
git clone https://github.com/nameissakthi/starHR.git
```
### **Navigate to the project directory**
```bash
cd starHR
```
### Install dependencies for frontend and backend separately
**Tip:** To efficiently install dependencies for frontend, admin and backend simultaneously, use split terminals.
**Install frontend dependencies**
```bash
cd starHR/frontend
npm install
```
**Install admin dependencies**
```bash
cd starHR/admin
npm install
```
**Install backend dependencies**
```bash
cd starHR/backend
npm install
```
### Environment Variables
**Backend**
- Create a `.env` file in the `backend` directory.
- Add the following variables with appropriate values
```bash
MONGODB_URI = ''
CLOUDINARY_API_KEY = ""
CLOUDINARY_SECRET_KEY = ""
CLOUDINARY_NAME = ""
```
**Frontend & Admin**
- Create a `.env` file in the `frontend & Admin` directory
- Add the following variable:
```bash
# Backend URL (adjust if needed)
VITE_BACKEND_URL="http://localhost:4000"
```
**Important**
- Replace all with your actual values.
- Exclude the `.env` file from version control to protect sensitive information.
**Important:**
- **Separate terminals**: Run the commands in separate terminal windows or use `split terminal` to avoid conflicts.
- **Nodemon required**: Ensure you have `nodemon` installed globally to run the backend development servers using `npm run dev`. You can install it globally using `npm install -g nodemon`.
#### Start the backend server
- Navigate to the `backend` directory: `cd backend`
- Start the server: `npm run server`
- You should see a message indicating the server is running, usually on port 4000 or you can specify it in the PORT environment variable inside `.env` file.
#### Start the frontend server:
- Navigate to the `frontend` directory: `cd frontend`
- Start the server: `npm run dev`
#### Start the admin server:
- Navigate to the `admin` directory: `cd admin`
- Start the server: `npm run dev`
## **Bonus**
Don't forget to star the repository and share your feedback!✨
## **LICENCE**
This project is licensed under the **GNU GENERAL PUBLIC LICENSE v3.0** License - see the [LICENSE](LICENSE) file for details.
## Author
- [Sakthivel](https://github.com/nameissakthi)
