github/zuauth
1
1
Fork 0
mirror of https://github.com/cedoor/zuauth.git synced 2026-01-09 12:47:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add readme for example project

Browse Source
This commit is contained in:
Jeeiii
2023-11-08 17:55:23 +01:00
parent 1b9adea6bb
commit 57eddfb6c0
2 changed files with 38 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -22,29 +22,11 @@
</a>
</p>
| The repository includes the `zuauth` package along with a documented example demonstrating how to create an authentication system using NextJS and IronSession. Use the [demo](https://zuauth.vercel.app/) and refer to the [tutorial](/#-tutorial) section below to understand how to integrate `zuauth` into your app. |
| The repository includes the `zuauth` package along with a documented [example](https://github.com/cedoor/zuauth/blob/main/example/README.md) demonstrating how to create an authentication system using NextJS and IronSession. Use the [demo](https://zuauth.vercel.app/) and refer to the [tutorial](/#-tutorial) section below to understand how to integrate `zuauth` into your app. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
```mermaid
sequenceDiagram
Zuauth-client->>Zuauth-server: getNonce()
Zuauth-server->>Zuauth-client: return <<nonce>>
Zuauth-client->>Zupass: requestPCD()
Zupass->>Zuauth-client: return <<ZKTicketPCD>>
Zuauth-client->>Zuauth-server: login()
Zuauth-server->>Zuauth-client: return <<cookie>>
```
## 🛠 Install
Copy the `.env` file as `.env.local`:
```bash
cp .env .env.local
```
And add your environment variables.
Install the `zuauth` package with npm:
```bash
@@ -58,10 +40,8 @@ yarn add zuauth
```
## 📜 Tutorial
This example includes an optional developer-friendly mode to select an arbitrary subset (from none to all) of ticket fields to be revealed during the authentication process. When the developer mode is off, only the pre-defined set of ticket fields (see step 2 below) will be displayed on the page. You can find multiple simple and specific components (e.g. Toggle) used to maintain the main page component easy to read and customize. The use of local storage allows consistency to be maintained after subsequent page refreshes.
> [!NOTE]
> The example in the repository uses [`iron-session`](https://github.com/vvo/iron-session) to manage sessions, but you are of course free to integrate your preferred solution.
> The [example](https://github.com/cedoor/zuauth/blob/main/example/README.md) in the repository uses [`iron-session`](https://github.com/vvo/iron-session) to manage sessions, but you are of course free to integrate your preferred solution.
### Server

36
example/README.md Normal file
View File

@@ -0,0 +1,36 @@
# ZuAuth Example
This example features an optional developer-friendly mode to choose an arbitrary subset (from none to all) of ticket fields to reveal during authentication with [zuauth](https://github.com/cedoor/zuauth/blob/main/README.md). With the developer mode disabled, only the predefined set of ticket fields (refer to the [Step 2](https://github.com/cedoor/zuauth/blob/main/README.md#client) below) will be displayed on the page. The main page component has multiple straightforward and tailored elements (e.g. Toggle) to ensure easy reading and customization. You can refer to an implementation of [iron-session](https://github.com/vvo/iron-session) for session management and usage of local storage to ensure consistency during page refreshes.
```mermaid
sequenceDiagram
Zuauth-client->>Zuauth-server: getNonce()
Zuauth-server->>Zuauth-client: return <<nonce>>
Zuauth-client->>Zupass: requestPCD()
Zupass->>Zuauth-client: return <<ZKTicketPCD>>
Zuauth-client->>Zuauth-server: login()
Zuauth-server->>Zuauth-client: return <<cookie>>
```
## 🛠 Install
Clone this repository:
```bash
git clone https://github.com/cedoor/zuauth.git
```
Navigate to the `example/` folder and install the dependencies:
```bash
cd zuauth/example && yarn # or npm i
```
## 📜 Usage
Copy the `.env` file as `.env.local`:
```bash
cp .env .env.local
```
And add your environment variables.