📝 Add basic READMEs

README.md

@@ -3,3 +3,51 @@
 # With WebAuthn
 
 A repository with full stack WebAuthn API examples.
+
+<div style="text-align:left">
+
+## Examples
+
+1. **[Passkeys with SimpleWebAuthn & Firebase](examples/simplewebauthn)**
+    - Creating (user registration), retrieving (user login), linking, removing of passkeys.
+    - Issuing a JWT token via Firebase Auth once user is authenticated.
+    - Passkes are stored in Firebase Firestore.
+    - Formatting and parsing of WebAuthn API request / responses done via SimpleWebAuthn library.
+
+---
+
+## Development
+
+### Common Stack notes:
+
+-   The whole project is managed using tuborepo and yarn workspaces.
+-   All examples are in NextJS (React) framework.
+-   API calls are handled with React Tanstack query on client.
+-   API endpoints are build via NextJS API routes.
+-   Forms are built with react-hook-form and validated with zod schemas.
+-   Material UI with styled components as UI SDK.
+
+### How to start the project locally?
+
+1. Initialize package manager:
+   Make sure you're running Node v20. Then initialize a package manager (corepack) by calling:
+
+    ```sh
+    corepack enable
+    corepack install
+    ```
+
+    It finds `packageManager` field and install Yarn 4.
+
+2. Install dependencies:
+
+    ```sh
+    yarn install --immutable
+    ```
+
+3. Then continue with final steps for specific example:
+    - [Passkeys with SimpleWebAuthn & Firebase](examples/simplewebauthn/README.md)
+
+## Have you a found a bug?
+
+Please, open an [Github issue](https://github.com/cermakjiri/with-webauthn/issues/new/choose). Thank you. ❤️

examples/simplewebauthn/README.md

@@ -0,0 +1,33 @@
+# Passkeys with SimpleWebAuthn & Firebase
+
+-   Creating (user registration), retrieving (user login), linking, removing of passkeys.
+-   Issuing a JWT token via Firebase Auth once user is authenticated.
+-   Passkes are stored in Firebase Firestore.
+-   Formatting and parsing of WebAuthn API request / responses done via SimpleWebAuthn library.
+
+## Development
+
+### How to start it locally?
+
+Assuming you've already finished [those steps in the main README](../../README.md), let's proceed:
+
+1. Setup Firebase:
+
+    1. Create a new Firebase project
+
+    2. Copy `.env.template.local` to `.env.local`:
+
+        - Fill up all those `NEXT_PUBLIC_FIREBASE_` env. vars.
+
+    3. Copy `.env.template.server` to `.env.server`:
+
+        - Create a new private key in `Firebase > Project settings > Service accounts`.
+        - Fill up all those `Firebase_` env. vars.
+
+    4. Don't forget to add `localhost` as Authorized domain in Firebase:
+
+        - Firebase > Authentication > Settings > Authorised domains.
+
+    5. Create a Firebase firestore database
+
+2. Run `yarn dev` and checkout `http://localhost:3000` URL.