https://github.com/r3dacted42/emperp

esd micro mini project, employee (and related tables) crud of erp system
https://github.com/r3dacted42/emperp

spring spring-boot spring-mvc spring-security

Last synced: 13 days ago
JSON representation

esd micro mini project, employee (and related tables) crud of erp system

• Host: GitHub
• URL: https://github.com/r3dacted42/emperp
• Owner: r3dacted42
• Created: 2024-11-20T19:43:32.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-11-29T10:18:48.000Z (2 months ago)
• Last Synced: 2025-01-29T18:11:49.131Z (13 days ago)
• Topics: spring, spring-boot, spring-mvc, spring-security
• Language: Java
• Homepage:
• Size: 378 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# EmpERP Backend 

ESD "Micro Mini" Project

Frontend: [/tree/frontend](https://github.com/r3dacted42/EmpERP/tree/frontend)

# Endpoints

- User Account `/api/v1/auth` *[does not require token]*

    - `/username-available?username={username}` GET -> check whether given username is available

    - `/register` POST -> create new user account

    - `/login` POST -> login to existing account

- Employee `/api/v1/employees`

    - `?department_id={department_id}/` GET -> get all employees (optional param: in the specified department)

    - `/{employee_id}` GET -> get employee with given employee_id

    - `/{employee_id}/photo` GET -> get photo of given employee *[does not require token]*

    - `/id-available?id={employee_id}` GET -> check whether given employee_id is available

    - `/` POST -> create employee

    - `/{id}` PATCH -> update employee with given id

    - `/{id}/photo` PATCH -> update employee's photo

    - `/{id}` DELETE -> delete employee with given id

- Department `/api/v1/departments`

    - `/` GET -> get all departments

    - `/{department_id}` GET -> get department with given id

    - `/` POST -> create department

    - `/{department_id}` PATCH -> update department with given id

    - `/{department_id}` DELETE -> delete department with given id

- Employee Salary `/api/v1/salaries`

    - `?employee_id={employee_id}/` GET -> get all salaries (optional param: of given employee)

    - `/{id}` GET -> get salary with given id

    - `/` POST -> create salary

    - `/{id}` PATCH -> update salary with given id

    - `/{id}` DELETE -> delete salary with given id

# Instructions to run

- open terminal in current folder and make sure MySQL is running

- run `.\mvnw spring-boot:run` (windows) or `./mvnw spring-boot:run` (linux)

- [optional] run the ~~`create.sql`, `alter.sql`, and~~ `insert.sql` script