Skip to content

Commit 9fa1949

Browse files
committed
fixed README.md
1 parent dd99ef2 commit 9fa1949

File tree

15 files changed

+40
-131
lines changed

15 files changed

+40
-131
lines changed

.mvn/wrapper/maven-wrapper.properties

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
wrapperVersion=3.3.2
18+
distributionType=only-script
19+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.0/apache-maven-3.9.0-bin.zip

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,15 @@ You can open it through **Swagger** as well.
2424

2525
Once the application is running, navigate to `http://localhost:9000/v1/api-docs` to access the Swagger UI.
2626

27-
## Run Locally
27+
## Requirements
28+
29+
## Getting Started
30+
31+
### Prerequisites
32+
- Java JDK 21
33+
- Maven (optional)
34+
35+
### Run Locally
2836

2937
Clone the project
3038

@@ -40,13 +48,19 @@ Navigate to the project directory
4048

4149
Set up [Environment Variables](#environment-variables)
4250

51+
Install dependencies
52+
53+
```bash
54+
./mvnw install
55+
```
56+
4357
Start the server
4458

4559
```bash
4660
./mvnw spring-boot:run -pl web
4761
```
4862

49-
## Environment Variables
63+
### Environment Variables
5064

5165
To run this project, you will need to add the following environment variables to your *.env* file. This project uses
5266
**PostgreSQL**, so create a database if you don't have one yet.

data/src/main/java/com/davidpokolol/parkingsystemapi/repository/ParkingRepository.java

+4
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,8 @@ public interface ParkingRepository extends JpaRepository<Parking, Long> {
1313

1414
List<Parking> findAllByParkingGarage(ParkingGarage parkingGarage);
1515

16+
17+
18+
19+
1620
}

data/target/maven-archiver/pom.properties

-3
This file was deleted.

data/target/maven-status/maven-compiler-plugin/compile/default-compile/createdFiles.lst

-13
This file was deleted.

data/target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst

-13
This file was deleted.

service/src/main/java/com/davidpokolol/parkingsystemapi/model/dto/ParkingGarageDTO.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33
import io.swagger.v3.oas.annotations.media.Schema;
44
import jakarta.validation.constraints.Max;
55
import jakarta.validation.constraints.Min;
6-
import jakarta.validation.constraints.NotBlank;
76
import jakarta.validation.constraints.NotNull;
87
import jakarta.validation.constraints.Size;
98

109
@Schema(name = "Parking Garage")
1110
public record ParkingGarageDTO(
1211
Long id,
13-
@NotBlank
12+
@NotNull
1413
@Size(min = 10, max = 60)
1514
String address,
1615
@NotNull

service/target/maven-archiver/pom.properties

-3
This file was deleted.

service/target/maven-status/maven-compiler-plugin/compile/default-compile/createdFiles.lst

-23
This file was deleted.

service/target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst

-23
This file was deleted.

web/src/main/java/com/davidpokolol/parkingsystemapi/model/response/ErrorResponse.java

-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
package com.davidpokolol.parkingsystemapi.model.response;
22

3-
import io.swagger.v3.oas.annotations.media.Schema;
43
import jakarta.validation.constraints.NotBlank;
54
import jakarta.validation.constraints.NotEmpty;
65

76
import java.util.List;
87

9-
@Schema(name = "Error Response")
108
public record ErrorResponse(@NotEmpty List<String> errors) {
119
public void addError(final @NotBlank String error) {
1210
errors.add(error);

web/target/maven-archiver/pom.properties

-3
This file was deleted.

web/target/maven-status/maven-compiler-plugin/compile/default-compile/createdFiles.lst

-22
This file was deleted.

web/target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst

-22
This file was deleted.

web/target/web-0.1.0.jar.original

-36.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)