Skip to content

Commit

Permalink
Update gh repo url and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kai-niemi committed Feb 7, 2024
1 parent 88f1c8f commit d192df5
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 18 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Burp-a-bet

[![Java CI with Maven](https://github.com/cloudneutral/burp-a-bet/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/cloudneutral/burp-a-bet/actions/workflows/maven.yml)
[![Java CI with Maven](https://github.com/kai-niemi/burp-a-bet/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/kai-niemi/burp-a-bet/actions/workflows/maven.yml)

<img align="left" src="logo.png" width="128" height="128" />

Expand Down Expand Up @@ -282,8 +282,8 @@ Customer service:

## Additional Documentation

- [High-Level Design](docs/DESIGN.md) - Details including architectural patterns and mechanisms.
- [Service Description](docs/diagrams.okso) - Using [C4 model](https://c4model.com/) diagrams drawn with the [okso](https://okso.app/) app _(open the file with the app)_.
- [Design Notes](docs/README) - Details including architectural patterns and mechanisms.
- [Service Description](docs/diagrams.okso) - [C4 model](https://c4model.com/) diagrams drawn with [okso](https://okso.app/) app _(open the file using the app)_.
- [Registration Journey Diagram](docs/registration-sequence.txt) - Using a [websequence](https://www.websequencediagrams.com/) diagram.

# Terms of Use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<title>Burp-a-bet</title>

<link rel="canonical" href="https://github.com/cloudneutral/burp-a-bet/">
<link rel="canonical" href="https://github.com/kai-niemi/burp-a-bet/">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3">
<link href="/webjars/bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet">

Expand Down Expand Up @@ -143,7 +143,7 @@ <h1 class="display-4 fw-normal text-body-emphasis">Bets</h1>
<div class="row">
<div class="col-12 col-md">
<img class="mb-2" alt="" width="64" height="64" th:src="@{/logo.png}">
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/cloudneutral/burp-a-bet">Betting and Auctioning</a></small>
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/kai-niemi/burp-a-bet">Betting and Auctioning</a></small>
</div>
<div class="col-6 col-md">
<h5>Features</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<title>Burp-a-bet</title>

<link rel="canonical" href="https://github.com/cloudneutral/burp-a-bet/">
<link rel="canonical" href="https://github.com/kai-niemi/burp-a-bet/">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3">
<link href="/webjars/bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet">
<link href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.3/gh-fork-ribbon.min.css"
Expand All @@ -20,7 +20,7 @@
</head>

<body>
<a class="github-fork-ribbon left-bottom fixed" href="https://github.com/cloudneutral/burp-a-bet"
<a class="github-fork-ribbon left-bottom fixed" href="https://github.com/kai-niemi/burp-a-bet"
data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>

<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
Expand Down Expand Up @@ -135,7 +135,7 @@ <h1 class="display-4 fw-normal text-body-emphasis">Welcome</h1>
<div class="col-12 col-md">
<img class="mb-2" alt="" width="64" height="64"
th:src="@{/logo.png}">
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/cloudneutral/burp-a-bet">Betting and Auctioning</a></small>
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/kai-niemi/burp-a-bet">Betting and Auctioning</a></small>
</div>
<div class="col-6 col-md">
<h5>Features</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<title>Burp-a-bet</title>

<link rel="canonical" href="https://github.com/cloudneutral/burp-a-bet/">
<link rel="canonical" href="https://github.com/kai-niemi/burp-a-bet/">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3">
<link href="/webjars/bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet">

Expand Down Expand Up @@ -134,7 +134,7 @@ <h1 class="display-6 fw-normal text-body-emphasis">You have been pwned by a grue
<div class="col-12 col-md">
<img class="mb-2" alt="" width="64" height="64"
th:src="@{/logo.png}">
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/cloudneutral/burp-a-bet">Betting and Auctioning</a></small>
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/kai-niemi/burp-a-bet">Betting and Auctioning</a></small>
</div>
<div class="col-6 col-md">
<h5>Features</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<title>Burp-a-bet</title>

<link rel="canonical" href="https://github.com/cloudneutral/burp-a-bet/">
<link rel="canonical" href="https://github.com/kai-niemi/burp-a-bet/">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3">
<link href="/webjars/bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet">

Expand Down Expand Up @@ -145,7 +145,7 @@ <h1 class="display-4 fw-normal text-body-emphasis">Races</h1>
<div class="col-12 col-md">
<img class="mb-2" alt="" width="64" height="64"
th:src="@{/logo.png}">
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/cloudneutral/burp-a-bet">Betting and Auctioning</a></small>
<small class="d-block mb-3 text-body-secondary">&copy; 2024 - <a href="https://github.com/kai-niemi/burp-a-bet">Betting and Auctioning</a></small>
</div>
<div class="col-6 col-md">
<h5>Features</h5>
Expand Down
10 changes: 8 additions & 2 deletions docs/DESIGN.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,17 @@ shows three categories of architectural mechanisms and shows how they are expres
| Eventing | Commit Log and Streaming | Kafka Streams used to link request and response topics. | |
| Web Server | Embedded Container | Embedded Jetty servlet container. | |
| Load Balancing | L4 / L7 | L4 load balancer between app instances and CockroachDB. L7 in front of app instances. | (Optional) Any load balancer, for example HAProxy in self-hosted. |
| Platform and Build | Java | JDK 17 | JDK 17 language level (OpenJDK compatible) |
| Frontend | HTML+CSS, Shell | Bootstrap 3 + Thymeleaf and/or Spring Shell | For applicable services- |
| Platform and Build | Java | JDK 17 | JDK 17 language level (OpenJDK compatible). |
| Frontend | HTML+CSS, Shell | Bootstrap 3 + Thymeleaf and/or Spring Shell | For applicable services. |

# Wallet Service

The service uses the following entity model for double-entry bookkeeping of monetary transaction history.

![schema](wallet-er.png)

[V1_0__create.sql](../burpabet-wallet-service/src/main/resources/db/migration/V1_0__create.sql)

- **account** - Accounts with a derived balance from the sum of all transactions
- **transaction** - Balanced multi-legged monetary transactions
- **transaction_item** - Association table between transaction and account representing a leg with a running account
Expand All @@ -47,6 +49,8 @@ The service uses the following entity model for double-entry bookkeeping of mone

![schema](customer-er.png)

[V1_0__create.sql](../burpabet-customer-service/src/main/resources/db/migration/V1_0__create.sql)

- **customer** - Customer registrations

# Betting Service
Expand All @@ -55,6 +59,8 @@ The service uses the following entity model for double-entry bookkeeping of mone

![schema](betting-er.png)

[V1_0__create.sql](../burpabet-betting-service/src/main/resources/db/migration/V1_0__create.sql)

- **race** - A race at a given track, with a given horse and the decimal odds
- **bet** - A customer bet for a given race

Expand Down
Binary file modified docs/betting-er.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/customer-er.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/wallet-er.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@
<inceptionYear>2024</inceptionYear>

<scm>
<connection>scm:git:https://github.com/cloudneutral/burp-a-bet.git</connection>
<developerConnection>scm:git:https://github.com/cloudneutral/burp-a-bet.git</developerConnection>
<url>https://github.com/cloudneutral/burp-a-bet.git</url>
<connection>scm:git:https://github.com/kai-niemi/burp-a-bet.git</connection>
<developerConnection>scm:git:https://github.com/kai-niemi/burp-a-bet.git</developerConnection>
<url>https://github.com/kai-niemi/burp-a-bet.git</url>
<tag>HEAD</tag>
</scm>

Expand All @@ -58,7 +58,7 @@

<issueManagement>
<system>GitHub</system>
<url>https://github.com/cloudneutral/burp-a-bet/issues</url>
<url>https://github.com/kai-niemi/burp-a-bet/issues</url>
</issueManagement>

<modules>
Expand Down

0 comments on commit d192df5

Please sign in to comment.