Skip to content

Commit 4811674

Browse files
authored
Update README.md
1 parent 611d029 commit 4811674

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,32 @@ stateDiagram
4747
}
4848
```
4949

50+
*Building and Testing*
51+
- [Maven](https://maven.apache.org/) as the project management for Building and Testing the application.
52+
The user input data from the app's view is stored in an Oracle (PDB) Database.
53+
54+
55+
# How to Demo
56+
For easy demos, an H2 database (Oracle Mode) is setup by default in the `src/main/resources/application.properties` file. </br>
57+
You can easily use a [GitHub codespaces](https://docs.github.com/en/enterprise-cloud@latest/codespaces) with this repository. </br>
58+
To set up your codespace, simply go to this repo [main page](https://github.com/octodemo/java-springboot-demo) --> Click **Code** --> Codespaces '+'. </br>
59+
You can run the `./build_and_run_app.sh` helper shell script and interact with the web app on `localhost:8086`.
60+
61+
62+
Running the CI workflow
63+
1. In order to run the workflow, you will need to [fork](https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo) this repo. </br>
64+
2. Then, make sure to save the following environment variables in your repository secrets so you can successfully run the Database schema mirgations scripts (using [Liquibase](https://www.liquibase.com/) as the schema migration tool) on application startup. </br>
65+
66+
Repository Secrets
67+
`LIQUIBASE_COMMAND_URL`
68+
`LIQUIBASE_COMMAND_USERNAME`
69+
`LIQUIBASE_COMMAND_PASSWORD`
70+
71+
If you are going to use the same service containers in the CI job for dev, then the default values should be: </br>
72+
`LIQUIBASE_COMMAND_URL` = `jdbc:oracle:thin:@oracle:1521/xe` </br>
73+
`LIQUIBASE_COMMAND_USERNAME` = `SYSTEM` </br>
74+
`LIQUIBASE_COMMAND_PASSWORD` = `ORACLE`
75+
5076
# Gitgraph Diagram - Developer Workflow
5177
```mermaid
5278
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true}} }%%
@@ -94,11 +120,3 @@ stateDiagram
94120
merge release
95121
```
96122

97-
*Building and Testing*
98-
- [Maven](https://maven.apache.org/) as the project management for Building and Testing the application.
99-
100-
101-
User input data is stored in an Oracle (PDB) Database.
102-
103-
104-
For easy demos, an H2 database (Oracle Mode) is setup by default in the `src/main/resources/application.properties` file.

0 commit comments

Comments
 (0)