Skip to content

Commit

Permalink
Merge pull request #1580 from webauthn4j/update-documents-regarding-s…
Browse files Browse the repository at this point in the history
…ample-apps

Update documents regarding sample applications
  • Loading branch information
ynojima authored Dec 24, 2024
2 parents 3db2d05 + 08ed5bf commit a187da8
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ git clone https://github.com/webauthn4j/webauthn4j-spring-security
./gradlew build
```

### Execute sample application
## sample applications

Sample applications are available in [webauthn4j-spring-security-samples](https://github.com/webauthn4j/webauthn4j-spring-security-samples)

```bash
./gradlew samples:spa:bootRun
Expand Down
5 changes: 2 additions & 3 deletions docs/src/reference/asciidoc/en/quick-start.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@

== Quick start

WebAuthn4J Spring Security contains a sample application which demonstrates its major functionality.

Sample applications demonstrating WebAuthn4J Spring Security major functionalities are available in https://github.com/webauthn4j/webauthn4j-spring-security-samples[webauthn4j-spring-security-samples].
It can be launched with the following command.

[source,bash]
----
./gradlew samples:spa:bootRun
./gradlew spa:bootRun
----

image::images/login.png[login view]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/reference/asciidoc/en/sample-app.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

== Sample application

WebAuthn4J Spring Security contains a sample application demonstrating its major functionalities.
Sample applications demonstrating WebAuthn4J Spring Security major functionalities are available in https://github.com/webauthn4j/webauthn4j-spring-security-samples[webauthn4j-spring-security-samples].
Sample SPA is a demo of Single Page Application. Sample MPA is a demo of traditional Multi Page Application.
Sample SPA is explained below.

Expand All @@ -11,7 +11,7 @@ Sample application can be executed by following command.

[source,bash]
----
./gradlew samples:spa:bootRun
./gradlew spa:bootRun
----

=== User and authenticator registration
Expand Down
4 changes: 2 additions & 2 deletions docs/src/reference/asciidoc/ja/quick-start.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

== クイックスタート

WebAuthn4J Spring Securityは主要機能をデモするサンプルアプリケーションを含みます
webauthn4j-spring-securityの主要機能をデモするサンプルアプリケーションは、 https://github.com/webauthn4j/webauthn4j-spring-security-samples[webauthn4j-spring-security-samples] に存在します

サンプルアプリケーションは以下のコマンドで実行することが出来ます。

[source,bash]
----
./gradlew samples:spa:bootRun
./gradlew spa:bootRun
----

image::images/login.png[ログイン画面]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/reference/asciidoc/ja/sample-app.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

== サンプルアプリケーション

webauthn4j-spring-securityは主要機能をデモするサンプルアプリケーションを含みます
webauthn4j-spring-securityの主要機能をデモするサンプルアプリケーションは、 https://github.com/webauthn4j/webauthn4j-spring-security-samples[webauthn4j-spring-security-samples] に存在します
Single Page Applicationのデモである、Sample SPAと、従来型のMulti Page Applicationである、Sample MPAです。以下ではSample SPAについて説明します。

=== サンプルアプリケーションの実行
Expand All @@ -10,7 +10,7 @@ Single Page Applicationのデモである、Sample SPAと、従来型のMulti Pa

[source,bash]
----
./gradlew samples:spa:bootRun
./gradlew spa:bootRun
----

=== ユーザーおよび認証デバイスの登録
Expand Down

0 comments on commit a187da8

Please sign in to comment.