Skip to content

Commit

Permalink
chore: clean up boilerplate/codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
danisharora099 committed Feb 27, 2025
1 parent 1d53e9c commit ab2e3cc
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 29 deletions.
55 changes: 32 additions & 23 deletions examples/keystore-management/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,45 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# Waku Keystore Management

## Getting Started
A simple Next.js application to manage Waku RLN keystores.

First, run the development server:
## Overview

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
This application provides an interface for managing keystores for Waku's rate-limiting nullifier (RLN) functionality. It integrates with MetaMask for wallet connectivity and demonstrates how to work with the Waku RLN library.

## Features

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- Connect to MetaMask wallet
- View wallet information including address, network, and balance
- Support for Sepolia testnet
- Keystore management functionality

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Getting Started

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
1. First, install the dependencies:

## Learn More
```bash
npm install
# or
yarn
```

To learn more about Next.js, take a look at the following resources:
2. Run the development server:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
```bash
npm run dev
# or
yarn dev
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
3. Open [http://localhost:3000](http://localhost:3000) with your browser.

## Deploy on Vercel
4. Connect your MetaMask wallet (Sepolia testnet is supported).

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## Technologies

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
- Next.js
- React
- TypeScript
- TailwindCSS
- Waku RLN library
- Ethers.js
3 changes: 2 additions & 1 deletion examples/keystore-management/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "keystore-management",
"name": "waku-keystore-management",
"version": "0.1.0",
"private": true,
"description": "A simple application to manage Waku RLN keystores",
"scripts": {
"dev": "next dev --turbopack",
"build": "next build",
Expand Down
1 change: 0 additions & 1 deletion examples/keystore-management/public/next.svg

This file was deleted.

1 change: 0 additions & 1 deletion examples/keystore-management/public/vercel.svg

This file was deleted.

4 changes: 2 additions & 2 deletions examples/keystore-management/src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ const geistMono = Geist_Mono({
});

export const metadata: Metadata = {
title: "RLN Keystore Management",
description: "Manage your RLN keystores",
title: "Waku Keystore Management",
description: "Manage your Waku RLN keystores securely",
};

export default function RootLayout({
Expand Down
1 change: 1 addition & 0 deletions examples/keystore-management/src/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export default function Home() {
<div className="max-w-4xl mx-auto">
<div className="bg-white rounded-lg shadow-md dark:bg-gray-800 p-6">
<h2 className="text-2xl font-bold text-center text-gray-900 dark:text-white">Waku Keystore Management</h2>
{/* Your keystore management content will go here */}
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion examples/keystore-management/src/components/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export function Header() {
<header className="sticky top-0 z-10 bg-white dark:bg-gray-900 shadow-sm">
<div className="container mx-auto px-4 py-3 flex justify-between items-center">
<div className="flex items-center">
<h1 className="text-xl font-bold text-gray-900 dark:text-white">RLN Keystore Management</h1>
<h1 className="text-xl font-bold text-gray-900 dark:text-white">Waku Keystore Management</h1>
</div>
<div className="w-80">
<WalletInfo />
Expand Down

0 comments on commit ab2e3cc

Please sign in to comment.