Skip to content

Commit 535fb45

Browse files
committed
Added swagger to readme
1 parent 690fce5 commit 535fb45

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,6 @@ Make sure to have the following installed, for backend application:
2121
* Any IDE: We recommend [VSCode](https://code.visualstudio.com/download)
2222
or [IntelliJ IDEA](https://www.jetbrains.com/idea/download/?section=mac)
2323

24-
### Running the frontend
25-
26-
To install the required dependencies (only once), from the `ui` directory, run:
27-
28-
```bash
29-
npm install
30-
```
31-
32-
To run the frontend application locally, from the `ui` directory, run:
33-
34-
```bash
35-
npm run dev
36-
```
37-
3824
### Running the backend
3925

4026
Starting all required dependencies for the CourseHub backend:
@@ -48,7 +34,7 @@ To run the backend application:
4834
* From Gradle: `./gradlew bootRun`
4935
* From IDE: Run the `CourseHubApplication` main class.
5036

51-
Now you can access the CourseHub UI on `http://localhost` and the backend API on `http://localhost:8080`.
37+
Now you can access the CourseHub UI on `http://localhost:5173` and the backend API on `http://localhost:8080`.
5238

5339
### Making requests
5440

@@ -57,6 +43,24 @@ Without authentication, you can only access the public endpoints, for example:
5743
curl http://localhost:8080/courses
5844
```
5945

46+
You can also see all available endpoints in the [OpenAPI documentation](http://localhost:8080/swagger/swagger-ui/index.html).
47+
48+
### Running the frontend
49+
50+
By default you get the the frontend running on `http://localhost:5173` from a docker compose, if you want to run it locally, follow the steps below.
51+
52+
To install the required dependencies (only once), from the `ui` directory, run:
53+
54+
```bash
55+
npm install
56+
```
57+
58+
To run the frontend application locally, from the `ui` directory, run:
59+
60+
```bash
61+
npm run dev
62+
```
63+
6064
### Building docker images
6165

6266
To build a Docker image of the course-hub backend, run the following command:

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ services:
1919
environment:
2020
BACKEND_URL: http://localhost:8080
2121
ports:
22-
- "80:80"
22+
- "5173:80"
2323
course-hub-backend:
2424
image: ghcr.io/hackyourfuture/course-hub-backend:latest
2525
container_name: course-hub

0 commit comments

Comments
 (0)