Skip to content

README.md

Latest commit

 

History

History
54 lines (36 loc) · 1.85 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.85 KB

🏗️ UNDP Create App CLI npm

@undp/create-app is UNDP’s official project scaffolding tool for quickly bootstrapping frontend applications using React, and TypeScript — complete with sensible defaults for ESLint, Prettier.

NPM Package

🚀 Features

  • ⚛️ React + TypeScript setup out of the box
  • 🖌️ Includes Tailwind CSS for styling
  • 🗂️ Includes Zustand for state management
  • 🚀 Vite support for fast SPA development, including optional routing with Tanstack router
  • 🌐 Next.js support for full-stack apps, including optional authentication with Better Auth
  • 🎨 Preconfigured for UNDP’s Design System
  • ⚡️ Optional integration with Tanstack query for data fetching
  • 📊 Optional integration with @undp/data-viz for interactive data visualization
  • ✨ ESLint + Prettier preconfigured for consistent code style

🧩 Pre-configured setups

All setups include Tailwind CSS for styling and Zustand for state management.

Framework Variants Description
Vite Basic Minimal React + TypeScript setup
Vite + Router Adds TanStack Router for routing
Next.js Basic SSR and file-based routing
Next.js + Auth Includes authentication via Better Auth

📦 Installation

You don’t need to install it globally — just use npx:

npx @undp/create-app my-undp-app

📦 Getting started

After running the CLI, navigate into your project and start the dev server:

cd my-undp-app && npm run dev

Please note: If you have not installed the dependencies then you might want to run npm install before npm run dev.