Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 3.81 KB

README.md

File metadata and controls

82 lines (54 loc) · 3.81 KB
Raw

🎒 Stackr Hackerpack

Docs | GitHub | Website

📦 Stackr Hackerpack is a collection of tools and libraries to help you build decentralized applications on the Stackr ecosystem. It includes a basic Counter micro-rollup and a companion Next.js frontend to help you get started with your project.

🛠️ Built using Stackr's SDK, NextJS, Privy, Wagmi and Viem.

  • 💭 Opinionated APIs: The included micro-rollup has a server exposed with some opinionated endpoints to get started easily.
  • 🪝 Frontend hooks: Hooks that makes it breezy to submit actions to Micro-rollup.
  • 🔐 Embedded Wallet: We have pre-configured Privy in this example, that can be easily extended to support in-browser wallets as wells as Embedded wallets linked to other identity providers.

Requirements

Below are the requirements to get started with the pack:

Get Started

To quickly get started, you can clone this repository and follow the steps below:

  1. Clone the repository
git clone [email protected]:stackrlabs/hackerpack.git
# OR if you want to clone particular branch, use command like below
git clone -b <branch> [email protected]:stackrlabs/hackerpack.git
  1. Initialize the project by running the setup script
cd hackerpack
./setup.sh
  1. Run the project with mprocs
npm run dev

This sets up the micro-rollup and the web app to run concurrently. You can now visit http://localhost:3000 to see the web app in action and interact with the rollup by sending actions.

By default Rollup runs on port 3210 Web App runs on port 3000

Caution

The project comes initialized with a default private key and Privy appId. It is strongly recommended to replace these with your own values in counter/.env and web/.env files respectively before deploying your application.

Documentation 📕

Checkout our docs to learn more about Micro-rollups, the Stackr ecosystem, and how to get started with new era of decentralized applications.

Wallet Setups ⚙️

This repo has been setup with Privy, and we have included three modes of wallet setups:

Mode Description Branch Deployment
Embedded Wallet with non-custodial wallet Auth Uses Privy's embedded wallet to sign transactions (signing pop-up can be suppressed) main Try it
Embedded Wallet with Social/Email Auth Uses Privy's embedded wallet to sign transactions (signing pop-up can be suppressed) social Try it
Using non-custodial wallet Uses your wallet to sign transactions (requires pop-up) non-custodial Try it

Hosting ☁️

  • Frontend: You can deploy the NextJS application to Vercel, Netlify, GitHub Pages or even other providers like AWS Amplify etc.

  • Micro-rollup: We have extensive guide here

More Micro-rollups 🤝

Refer to the awesome-micro-rollups for a curated list of applications leveraging Micro-rollups.

For more information, you can reach out to us on our Discord.