Skip to content

Commit 827d3e8

Browse files
authored
Create README.md
1 parent 99af265 commit 827d3e8

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

README.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
3+
4+
# Employee Management System API w/SpringBoot&MySql
5+
6+
This is a RESTful API for managing employees in a company. It is developed using Spring Boot and utilizes a local MySQL database for data storage.
7+
8+
## Features
9+
10+
- Create, read, update, and delete employees,industries and departments.
11+
- Retrieve a list of all employees or search for employees by specific criteria.
12+
- Supports basic CRUD operations for managing employee data.
13+
14+
## Getting Started
15+
16+
To get started with the Employee Management System API, follow the instructions below.
17+
18+
### Prerequisites
19+
20+
- Java Development Kit (JDK) installed on your machine.
21+
- XAMPP or any other MySQL server installed for managing the database.
22+
23+
### Setup
24+
25+
1. Clone the repository:
26+
27+
```shell
28+
git clone <repository_url>
29+
```
30+
31+
2. Set up the MySQL database:
32+
33+
Install XAMPP or any other MySQL server.
34+
Create a new database called employee_management_system using a MySQL client or the command line.
35+
Configure the database connection:
36+
37+
Open the application.properties file located in the src/main/resources directory.
38+
39+
Modify the following properties to match your MySQL database configuration:
40+
41+
properties
42+
```
43+
spring.datasource.url=jdbc:mysql://localhost:3306/employee_management_system
44+
spring.datasource.username=<your_database_username>
45+
spring.datasource.password=<your_database_password>
46+
47+
```
48+
49+
50+
3. Build and Run
51+
52+
53+
```
54+
mvn clean install
55+
56+
java -jar target/employee-management-system-api.jar
57+
```
58+
59+
The API will be accessible at http://localhost:8080/api/v1/
60+
61+
62+
## Contributions
63+
64+
Feel free to do whatever you want with this , i don't really care it's some basic stuff for newbies :')
65+
66+
67+
68+
69+

0 commit comments

Comments
 (0)