Skip to content

zkemail/frontend-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zkEmail Frontend Boilerplate

This is a frontend boilerplate designed for projects built by zkEmail. It comes preconfigured with essential utilities and libraries to streamline development for zkEmail-based applications.

Features

  • Preconfigured with @zk-email/relayer-utils: Easily integrate with zkEmail's relayer infrastructure.
  • Includes @zk-email/sdk: Provides necessary SDK utilities for seamless interaction with zkEmail.
  • Integrated zk-emails component library: Ready-to-use UI components tailored for zkEmail applications.
  • Optimized for rapid development: Comes with a clean project structure, essential dependencies, and best practices for frontend development.

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (>= 18.x)
  • Yarn or npm

Installation

Clone the repository and install dependencies:

# Using Git
git clone https://github.com/zkemail/frontend-boilerplate.git
cd frontend-boilerplate

# Install dependencies
yarn install  # or npm install

Linking this boilerplate on your package manager

yarn link

Creating a new project

create-zkemail-frontend-boilerplate

Contributing

We welcome contributions! Feel free to submit issues and pull requests.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •