Skip to main content

Get Started with StarterKit

djuno starterkit repository gives you a bioulerplate to rapidly start developing on your djuno development portal

Djuno Support avatar
Written by Djuno Support
Updated this week

🚀 djuno-app-starterkit

A modern starter kit for building decentralized applications (dApps) with Djuno Cloud. It includes built-in support for Web3Auth, IPFS integration, and automated workflows. The UI is powered by djuno-design, a sleek component library built for Djuno-based apps.

🌿 Branch Overview

This repository offers different starter flavors depending on your preferred integration method with Djuno Cloud:

Branch

Description

Related Package(s)

main

Built for React-based projects, this version uses @djuno/web3auth-hook, a lightweight wrapper providing React hooks around the core SDK. It simplifies integration while leveraging the same underlying @djuno/web3auth-sdk.

@djuno/web3auth-hook (built on top of @djuno/web3auth-sdk)

sdk-version

Uses the @djuno/web3auth-sdk package to provide a full-featured, modular SDK for Web3 authentication and wallet integration. This version is suitable for developers who want fine-grained control and direct SDK access.

@djuno/web3auth-sdk

purejs-version

Basic starter with direct REST API calls using axios and environment-based configuration.

Native REST

✨ Choose the branch that matches your preferred abstraction level and framework.

⚙️ Environment Setup

Before running the project, create a .env.local file in the root and add the following variables:

REACT_APP_API_URL=https://web3auth.djuno.cloud/v1 REACT_APP_ACCESS_KEY=<<YOUR_ACCESS_KEY_WEB3_AUTH>> REACT_APP_WORKFLOW_URL=<<WF-WEBHOOK>> REACT_APP_IPFS_URL=<<IPFS_URL>> REACT_APP_IPFS_API_KEY=<<IPFS_KEY>>

⚠️ Never commit or expose your .env.local file publicly.

🛠️ Getting Started (Local Development)

  1. Clone the repository

git clone https://github.com/your-org/djuno-app-starterkit.git cd djuno-app-starterkit

  1. Install dependencies

npm install

  1. Run the app

npm start

The development server will start at http://localhost:7200

Windows users can use:

npm run start:win

🐳 Running with Docker Compose

If you'd like to run the app as a production-ready static site served by Nginx:

  1. Ensure your .env.local is set up as shown above.

  2. Build and run the container:

docker compose up --build

  1. Visit your app at http://localhost:8080

This will:

  • Embed the environment variables during the build

  • Build the React app with react-app-rewired build

  • Serve the compiled app using Nginx

The Dockerfile and Nginx config are included in the repo.

📜 Available Scripts

  • npm start: Runs the app in development mode (Linux/macOS)

  • npm run start:win: Same as above (for Windows environments)

  • npm run build: Builds the app for production

  • npm test: Launches the test runner

  • npm run eject: Ejects CRA configuration (not reversible)

🌐 Djuno Cloud Integrations

Feature

Service

Documentation Link

Web3Auth

Web3Auth Service

Web3Auth Docs

IPFS Uploads

IPFS API

IPFS Docs

Workflows

Workflow Automation

Workflow Docs

🚀 Deployment

After building the project using:

npm run build

You can deploy the contents of the /build folder to any static hosting provider, including:

  • Vercel

  • Netlify

  • GitHub Pages

  • Firebase Hosting

  • AWS S3 + CloudFront

🤝 Contributing

We welcome contributions! Feel free to open an issue or submit a pull request.

# Create a new branch git checkout -b feature/my-feature # Commit changes git commit -m "Add my feature" # Push and open a PR git push origin feature/my-feature


​

Related Articles
API Reference
@djuno/web3auth-hook
Did this answer your question?