customer-app

Customer Loyalty Program: Customer App

A composable solidity protocol and lightweight dApp for real-world customer engagement

Conceptual overview · Getting Started · Live version

What's included

Next.js - Framework
ReOwn - Wallet Framework
TailwindCSS - Styling
TypeScript - Type safety
Redux - state management

Directory Structure

./nextjs/customer-app
├── .well-known             # ReOwn appKit id
├── public                  # Public assets
├── src                     # Source code
│   ├── app                 # Reusable components
|   │   ├── about           # About page
|   |   │   └── ...         
|   │   ├── exchangePoints  # Exchange points page
|   |   │   └── ...         
|   │   ├── home            # Home page
|   |   │   └── ...         
|   │   ├── redeemGifts     # Redeem Gifts page
|   |   │   └── ...         
|   │   ├── settings        # Settings page
|   |   │   └── ...         
|   │   ├── globals.css     # Styling files
|   │   ├── layout.tsx      # Layout
|   │   ├── Loader.tsx      # Loader components
|   │   └── page.tsx        # landing page
│   ├── components          # Reusable components
|   │   └── ...             
│   ├── context             # Abi, chains, clients, providers. 
|   │   └── ...             
│   ├── hooks               # Custom hooks
|   │   ├── useLoyaltyCards # Hook interacting with bespoke ERC-4337 implementation 
|   │   └── ...             
│   ├── redux               # Redux store 
|   │   └── ...             
│   ├── types               # Type safety 
|   │   └── index.d.ts      
│   └── utils               # Utility functions
|       └── parsers.ts      # parsers
├── .env.example            # Example environment variables
├── LICENSE                 # License information
├── README.md               # Project documentation
└── ...                     

Getting Started

1. Install the dependencies

yarn install 

2. Copy .env.example to .env and update the variables.

# Copy .env.example to .env. Acquire and fill out missing keys. 
cp apps/api/.env.example apps/api/.env

3. run the development server:

yarn dev

Open http://localhost:3001 with your browser to see dashboard.

Live version

A live version can be seen on vercel.