Staking Starter Kit

Purpose

The Staking Starter Kit is a boilerplate project designed to help businesses launch their own Staking. It includes a Next.js frontend with TypeScript, Tailwind CSS, and React Query, as well as a Liteflow SDK backend to manage quests and leaderboards.

Features

• Staking: Users can stake tokens token anytime to earn rewards.
• Claim rewards: Users can claim rewards anytime.
• Unstake: Users can unstake tokens anytime.

Setup

Follow these steps to set up the project:

Clone the repository:

git clone https://github.com/liteflow-labs/staking-starter-kit.git
cd staking-starter-kit

Install dependencies:

npm install

Run the development server:

npm run dev

Build the application:

npm run build

Start the production server:

npm start

Configuration

The project uses environment variables to configure the frontend and backend. Create a .env.local file in the root of the project and add the following variables:

# Create your project ID on https://reown.com/
NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID=

# Create your Liteflow API key on https://dashboard.liteflow.com/developers
NEXT_PUBLIC_LITEFLOW_API_KEY=

# Chain ID of the staking contract created on https://dashboard.liteflow.com/engagements/stakings/create
NEXT_PUBLIC_STAKING_CHAIN=

# Address of the staking contract created on https://dashboard.liteflow.com/engagements/stakings/create
NEXT_PUBLIC_STAKING_CONTRACT=

The UI is built with Tailwind CSS and shadcn/ui, so you can customize the styles by editing the tailwind.config.js file and by importing components from the shadcn/ui library.

The application uses Wagmi and RainbowKit for wallet connection.

Deployment

The project is designed to be deployed to Vercel. You can deploy the project by connecting your GitHub repository to Vercel and configuring the environment variables in the Vercel dashboard.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License.