Skip to content

Commit fbda3d4

Browse files
authored
Update README.md
1 parent 4810c4e commit fbda3d4

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,29 @@ This project is a web-based Kanban system for project management. It allows user
2525

2626
## Configuration and Usage
2727

28-
1. **Clone the repository:** `git clone https://github.com/your-username/kanban-project-management.git`
28+
1. **Clone the repository:** `git clone https://github.com/Pezcue/SpringBootRest.git`
2929
2. **Configure the MySQL database:** Update the `application.properties` file with your database configuration.
3030
3. **Compile and run the application:** `mvn spring-boot:run`
3131
4. **Access the application:** Open your browser and go to `http://localhost:8080`
3232
5. **Explore the API:** Use Swagger UI to explore and test the API endpoints at `http://localhost:8080/swagger-ui.html`
3333

3434
## Main Endpoints
3535

36-
-`POST /v1/projects`: Create a new project.
37-
- ✏️ `PUT /v1/projects/{id}`: Update an existing project.
36+
### Project Endpoints
37+
38+
-`POST /v1/projects/`: Create a new project.
39+
- ✏️ `PUT /v1/projects/{id}`: Edit an existing project.
3840
-`DELETE /v1/projects/{id}`: Delete a project.
3941
- 📝 `GET /v1/projects/{id}`: Get a project by its ID.
4042
- 📊 `GET /v1/projects/{id}/board`: Get all tasks of a project grouped by status.
41-
- 🔧 `PATCH /v1/task/{id}`: Update the status of a task.
4243
-`GET /v1/projects/{id}/due-task`: Get overdue tasks of a project.
4344

45+
### Task Endpoints
46+
-`POST /v1/task/project/{1id}`: Create a new Task.
47+
- ✏️ `GET /v1/task/{id}`: Edit an existing Task.
48+
-`DELETE /v1/task/{id}`: Delete a Task.
49+
- 🔧 `PATCH /v1/task/{id}`: Update the status of a task.
50+
4451
## Authentication and Authorization
4552

4653
The API uses JWT (JSON Web Tokens) for user authentication and authorization. To obtain an access token, follow these steps:

0 commit comments

Comments
 (0)