README.md 2.29 KB
Newer Older
Karakas's avatar
Karakas committed
1
2
3
4
5
6
7
8
## Before you start this application

1. You have to install Maven:

   1. Have a JDK installation on your system. Either set the JAVA_HOME environment variable pointing to your JDK installation or have the java executable on your PATH.
   2. Download zip from here [https://maven.apache.org/download.cgi]
   3. Extract distribution archive in any directory
   4. Unzip apache-maven-3.9.7-bin.zip
Karakas's avatar
Karakas committed
9
   5. Add the bin directory of the created directory apache-maven-3.9.7 to the PATH environment variable.
Karakas's avatar
Karakas committed
10
11
12
13
14
15
16
17
18
   6. Confirm with ```mvn -v``` in a new shell. The result should look similar to

      ```Apache Maven 3.9.7 (8b094c9513efc1b9ce2d952b3b9c8eaedaf8cbf0)
      Maven home: /opt/apache-maven-3.9.7
      Java version: 1.8.0_45, vendor: Oracle Corporation
      Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk/Contents/Home/jre
      Default locale: en_US, platform encoding: UTF-8
      OS name: "mac os x", version: "10.8.5", arch: "x86_64", family: "mac"```

Karakas's avatar
Karakas committed
19
2. You have to install node:
Karakas's avatar
Karakas committed
20
21
22
23
24
25

   1. Download the installer here [https://nodejs.org/en/download/prebuilt-installer]
   2. Click through the installer
   3. Confirm with ```node -v``` in a new shell. The result should look similar to ```v20.14.0```
   4. Confirm with ```npm -v```. The result should look similar to ```10.7.0```

Karakas's avatar
Karakas committed
26
27
28
29
30
3. If using Chrome, you have to install a extension:

   1. Download extension here [https://chromewebstore.google.com/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf]
   2. Activate extension

EnesKarakas's avatar
Done    
EnesKarakas committed
31
## How to start this application
Karakas's avatar
Karakas committed
32
33
34
35
36
1. Open up project in VSCode
2. Open up a terminal
3. Type: ```./mvnw spring-boot:run```
4. Open up another terminal
5. Type: ```cd frontend```
Karakas's avatar
Karakas committed
37
6. If running for the first time, Type: ```npm install```
Karakas's avatar
Karakas committed
38
7. Type: ```npm run start``` (for dev) or ```npm run build``` (for production)
EnesKarakas's avatar
EnesKarakas committed
39

EnesKarakas's avatar
Done    
EnesKarakas committed
40
## How to stop this application
EnesKarakas's avatar
EnesKarakas committed
41

EnesKarakas's avatar
Done    
EnesKarakas committed
42
1. Go to both Terminals
Karakas's avatar
Karakas committed
43
44
2. Press ```Ctrl + C```
3. Type: ```j```
Karakas's avatar
Karakas committed
45
4. Deactivate Chrome extension
Karakas's avatar
Karakas committed
46
47
48
49
50
51


## Troubleshooting

1. There are errors all over the backend.<br/>
   You have to reload the Maven project. In VSCode navigate to "Maven" on the lower left corner and press the reload button.
Karakas's avatar
Karakas committed
52
53
54

2. Backend Server doesn't start / it throws errors.<br/>
   You can alternatively start the server with VSCode. Navigate to src/main/java/io/swagger/Swagger2SpringBoot.java and press "Run"