Prerequisites

• Node.js >= 20.17.0
• pnpm >= 9.13.0
• Docker & Docker Compose (for containerized development)

Getting Started

Local Development

1. Install dependencies:

pnpm i

2. Start the development servers:

# Start both web and API services
pnpm dev

The web application will be available at http://localhost:3000 The API server will be available at http://localhost:3001

Lint check

To lint the codebase, run the following command:

pnpm lint

This will check for code quality and style issues across the entire monorepo.

Unit tests

To run the tests, use the following command:

pnpm test

Docker Development Environment

The project includes a Docker setup for consistent development environments:

# Start all services
docker-compose up --build

# Stop services
docker compose down

Environment Variables

Create a .env file in the root directory:

NEXT_PUBLIC_API_HOST=localhost  # API host for web application

Development Tools

• TypeScript
• ESLint for code linting
• Jest for testing
• PAPI for Polkadot chain interactions

Learn More

• Next.js Documentation
• Polkadot-API Documentation

Acknowledgements

Check out the NOTICE.md file for more details.