Skip to content

Commit aeafcfd

Browse files
committed
Updated readme.
1 parent a402cc9 commit aeafcfd

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

Diff for: README.md

+63-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,63 @@
1-
# User-Management-JavaSpringBoot
1+
# User Management - Java Spring Boot
2+
3+
This is a simple Java Spring Boot project designed for User Management with two types of user roles: USER and ADMIN. Authentication is implemented using JSON Web Tokens (JWT), and the default port for the application is 8080. Maven is used as the build tool, and Postgres SQL is the chosen database with JPA for database access.
4+
5+
## Features
6+
7+
- User Management with roles: USER and ADMIN
8+
- JWT Authentication
9+
- Database: Postgres SQL with JPA
10+
- Default Port: 8080
11+
12+
---
13+
14+
## Getting Started
15+
16+
### Prerequisites
17+
18+
Make sure you have the following installed:
19+
20+
- Java Development Kit (JDK)
21+
- Maven
22+
- Postgres SQL
23+
24+
### Installation
25+
26+
1. **Clone the repository:**
27+
28+
```
29+
git clone https://github.com/alwinsimon/User-Management-JavaSpringBoot.git
30+
```
31+
32+
2. **Navigate to the project directory:**
33+
34+
```
35+
cd User-Management-JavaSpringBoot
36+
```
37+
38+
3. **Build the project using Maven:**
39+
40+
41+
42+
4. **Run the application:**
43+
44+
45+
The application will start on the default port: [http://localhost:8080](http://localhost:8080).
46+
47+
---
48+
49+
## API Documentation
50+
51+
Explore the API endpoints using the [Postman live API Documentation](https://documenter.getpostman.com/view/27773540/2s9Ykhgj5q).
52+
53+
## Contributing
54+
55+
Feel free to contribute to the project by creating issues or submitting pull requests.
56+
57+
## License
58+
59+
This project is licensed under the [Apache License](LICENSE).
60+
61+
---
62+
63+
**Repository:** [https://github.com/alwinsimon/User-Management-JavaSpringBoot](https://github.com/alwinsimon/User-Management-JavaSpringBoot)

0 commit comments

Comments
 (0)