Skip to content

Latest commit

Β 

History

History
59 lines (39 loc) Β· 2.36 KB

README.md

File metadata and controls

59 lines (39 loc) Β· 2.36 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 Biome.

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
  • πŸ”£ Optional integration with i18next for internationalization
  • ✨ Biome preconfigured for consistent code style

🧩 Pre-configured setups

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

Framework Variants Description Internationalization Available
Vite ⭐ Recommended Basic Minimal React + TypeScript setup βœ…
Vite ⭐ Recommended + Router Adds TanStack Router for routing βœ…
Next.js Basic SSR and file-based routing ❌
Next.js + Auth Includes authentication via Better Auth ❌

Note: Vite is the primary focus of this scaffolding. Its setups are the most mature and feature-complete, including i18n support. The Next.js setups are more experimental and may lag behind.


πŸ“¦ 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.

Please note: The scaffolding tool installs Proxima Nova and Sonhe Breit fonts; you can only use these fonts if you have a license or are using the app as UNDP sub-domain.