Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dan-niles/jupiter-frontend

Frontend of group project for CS3043: Database Systems (Human Resource Management System)
https://github.com/dan-niles/jupiter-frontend

cs3043 material-ui react

Last synced: 3 days ago
JSON representation

Frontend of group project for CS3043: Database Systems (Human Resource Management System)

Awesome Lists containing this project

README

        

# Jupiter HRM - Frontend

## Background

This application was developed for the group project of CS3043: Database Systems.

Backend of the application can be found [here](https://github.com/dan-niles/jupiter-backend)

### Problem Statement

Jupiter Apparels is a multinational corporation with over 1000 employees. Currently the branches of Jupiter are at Sri Lanka, Bangladesh and Pakistan. Although they use SAP as the ERP to manage key activities of the organization, the management has felt that SAP is too much of an overheard in a management perspective. On one hand it requires specifically trained SAP engineers to do the slightest change while training management employee to use the system is a hassle. Hence, Jupiter has requested our team come up with a easy to use human resource management system as the initial phase.

Read more [here](project-description.pdf).

## Screenshots

### Login

![Login](screenshots/login_screen.png)

### Admin Dashboard

![Admin Dashboard](screenshots/admin_dashboard.png)

### Employee Dashboard

![Employee Dashboard](screenshots/user_dashboard.png)

### Users Panel

![Users Panel](screenshots/users_panel.png)

### Leave History

![Leave History](screenshots/leave_history.png)

### Leave Application

![Leave Application](screenshots/leave_application.png)

### Reports

![Reports](screenshots/reports.png)

## The Stack

The application uses MySQL for the database. The frontend is built using React and the backend is made using Node.js and Express.

## Getting Started

### Prerequisites

Install Node JS : Refer to https://nodejs.org/en/ to install nodejs

### Cloning and Running the Application in local

Clone the project into local

```bash
git clone https://github.com/HRM-Solutions/jupiter-hrm-fe.git
```

Install all the npm packages. Go into the project folder and type the following command to install all npm packages

```bash
npm install
```

In order to run the application type the following command

```bash
npm start
```

The application runs on **localhost:3000**

### Environment Variables

Create a `.env` file inside the cloned directory and define the following variable

```
REACT_APP_BACKEND_URL=url_for_backend
```

## Contribution

Group 10 members:

- Kobinath A. (200308F)
- Muaadh M.N.M. (200401J)
- Mushraf M.I.M. (200404V)
- Niles D.A. (200421U)
- Rajeevan Y. (200501P)