Skip to content

Commit bcab593

Browse files
committed
GH-119: Added missing information to the readme file
1 parent 1746992 commit bcab593

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

Diff for: README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,23 @@ To execute both the web app, the server app and the database:
7474
- `CG_CLIENT_ID`
7575
- `CG_CLIENT_SECRET`
7676
- `CG_WEB_CIPHER_KEY`
77-
- Execute the following command:
77+
- Execute the following commands in order:
7878
```sh
79+
# Build and extract uber jar in order to build the docker image (invert '/' if using Windows)
80+
code/jvm/gradlew -p code/jvm extractUberJar
81+
82+
# Go to the web app's directory
83+
cd code/js
84+
85+
# Install npm dependencies
86+
npm install
87+
88+
# Transpile TypeScript code into Javascript
89+
npm run tsc
90+
91+
# Go back to the root directory
92+
cd ../..
93+
7994
docker-compose -f .docker/docker-compose.yml up
8095
```
8196
- The web application should now be available on port `80` and the server application on port `8080`
@@ -163,8 +178,8 @@ To run the i-on CodeGarten server app locally with Docker, the `env_server` file
163178
After setting up the environment file, the server app can be executed using the `docker-compose.yml` Docker Compose file present in the `.docker` directory:
164179

165180
```sh
166-
# Build (without tests) and extract uber jar in order to build the docker image (invert '/' if using Windows)
167-
code/jvm/gradlew -p code/jvm extractUberJar -x test
181+
# Build and extract uber jar in order to build the docker image (invert '/' if using Windows)
182+
code/jvm/gradlew -p code/jvm extractUberJar
168183

169184
# Run the server and both the database and test database on three containers
170185
docker-compose -f .docker/docker-compose.yml up codegarten-server

0 commit comments

Comments
 (0)