Skip to content

Commit 61d4e4e

Browse files
committed
Move recommended development tools to its own section
1 parent dd6c90a commit 61d4e4e

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,17 @@ You can access a live demo of CourseHub at: [https://coursehub.hyf.dev](https://
1212

1313
## Development
1414

15-
### Prerequisites
15+
### Recommended Development Tools
1616

17-
Make sure to have the following installed, for backend application:
17+
* Any IDE: We recommend [VSCode](https://code.visualstudio.com/download)
18+
or [IntelliJ IDEA](https://www.jetbrains.com/idea/download/?section=mac)
19+
20+
### Prerequisites to Run the Application
21+
22+
Make sure to have the following installed, for the backend application:
1823

1924
* [Java 21 or later](https://adoptium.net/temurin/releases)
2025
* [Docker](https://www.docker.com/products/docker-desktop/)
21-
* Any IDE: We recommend [VSCode](https://code.visualstudio.com/download)
22-
or [IntelliJ IDEA](https://www.jetbrains.com/idea/download/?section=mac)
2326

2427
Make sure to have the following installed, for the frontend application:
2528

@@ -43,6 +46,7 @@ Now you can access the CourseHub UI on `http://localhost:80` and the backend API
4346
### Making requests
4447

4548
Without authentication, you can only access the public endpoints, for example:
49+
4650
```bash
4751
curl http://localhost:8080/courses
4852
```
@@ -51,7 +55,8 @@ You can also see all available endpoints in the [OpenAPI documentation](http://l
5155

5256
### Running the frontend
5357

54-
By default you get the the frontend running on `http://localhost:80` from a docker compose, if you want to run it locally, follow the steps below.
58+
By default you get the the frontend running on `http://localhost:80` from a docker compose, if you want to run it
59+
locally, follow the steps below.
5560

5661
To install the required dependencies (only once), from the `ui` directory, run:
5762

@@ -70,24 +75,31 @@ With this you can now access the CourseHub UI on `http://localhost:5173` in deve
7075
### Building docker images
7176

7277
To build a Docker image of the course-hub backend, run the following command:
78+
7379
```bash
7480
./gradlew bootBuildImage
7581
```
82+
7683
To build a Docker image for the frontend, from the `ui` directory, run:
84+
7785
```bash
7886
docker build -t ghcr.io/hackyourfuture/course-hub-frontend ui
7987
```
8088

8189
#### Running docker image
8290

83-
After the image is built, you can run it using a special Docker Compose profile _(make sure you stop the application if you're running it from Gradle or IDE)_:
91+
After the image is built, you can run it using a special Docker Compose profile _(make sure you stop the application if
92+
you're running it from Gradle or IDE)_:
93+
8494
```bash
8595
docker compose --profile include-course-hub up
8696
```
8797

8898
### Cleanup
8999

90-
Keep in mind that containers will keep running in the background even after you stop the application. To stop and remove the containers, run:
100+
Keep in mind that containers will keep running in the background even after you stop the application. To stop and remove
101+
the containers, run:
102+
91103
```bash
92104
docker compose --profile include-course-hub down -v
93105
```

0 commit comments

Comments
 (0)