Description
Cache Up is a simple employee management system that provides broad monitoring capabilities, allowing users to track the employment status of employees across all departments and branches. It enables monitoring of departmental operations as well as the status and activities of existing branches.
Additionally, the system facilitates efficient management of employee leave and absences, along with associated actions. Furthermore, it includes features for managing employee benefits and maintaining accurate records of employee documents, allowing for seamless updates with new and revised documents.
This project is built using React, TypeScript, and Tailwind CSS.
Prerequisites
- Ensure you have Node.js and npm installed. You can download them from Node.js.
-
- To test that you have Node.js and npm correctly installed on your machine, you can type node --version and npm --version in a terminal or command prompt.
- Install React (Vite)
- Add Tailwind CSS to your Project
Module installation
# using npm:
npm installRunning the app
# using npm (Vite):
npm run devDocumentation
System Documentation
Prototype
System Prototype
Features
Features
Endpoints
## AUTHENTICATION
SIGNUP
POST: 10.10.10.10:3000/auth/signup
> email
> username
> password
> firstName
> lastName
> month
> day
> year
> phone
> sex
LOGIN
POST: 10.10.10.10:3000/auth/login
> username
> password
REFRESH TOKEN
POST: 10.10.10.10:3000/auth/refresh
> refreshToken
LOGOUT
POST: 10.10.10.10:3000/auth/logout
> accessToken
## BRANCHES
GET BRANCH
GET: 10.10.10.10:3000/branches
ADD BRANCH
POST: 10.10.10.10:3000/branches
> file
> name
> address
EDIT BRANCH
PATCH: 10.10.10.10:3000/branches
> bid (branch ID)
> file
> name
> address
STATUS BRANCH
PATCH: 10.10.10.10:3000/branches
> bid (branch ID)
> status
IMAGE BRANCH
GET: 10.10.10.10:3000/branches/:balias/:bimage
> alias
> image
## DEPARTMENT
GET DEPARTMENT
GET: 10.10.10.10:3000/departments
ADD DEPARTMENT
POST: 10.10.10.10:3000/departments
> bid (branch ID)
> name
> email
> phone
EDIT DEPARTMENT
PATCH: 10.10.10.10:3000/departments
> did (department ID)
> bid (branch ID)
> name
> email
> phone
STATUS DEPARTMENT
PATCH: 10.10.10.10:3000/departments
> did (department ID)
> status
## POSITIONS
GET POSITIONS
GET: 10.10.10.10:3000/positions
GET DEPARTMENT POSITIONS
GET: 10.10.10.10:3000/banch/:balias/department/:dalias/positions
ADD POSITIONS
POST: 10.10.10.10:3000/banch/:balias/department/:dalias/positions
> did (department ID)
> name
> hierarchy
EDIT POSITIONS
PATCH: 10.10.10.10:3000/banch/:balias/department/:dalias/positions
> pid (position ID)
> did (department ID)
> name
> hierarchy