@undp/create-app 0.1.1 → 0.2.0

package/bin/templates/next/withDataViz/auth/README.md

@@ -0,0 +1,108 @@
+This is a Next.js project powered by Tailwind CSS, the UNDP Design System, and the UNDP Data Visualization Library, bootstrapped with [@undp/create-app](https://www.npmjs.com/package/@undp/create-app). 
+
+It includes:
+* Next 16.x with React compiler
+* UNDP Design System
+* UNDP Data Visualization library
+* Authentication with [Better Auth](https://www.better-auth.com/)
+* TailwindCSS
+* Code linting and formatting via ESLint and Prettier
+
+## 🧩 Installation
+
+This project uses `npm`. 
+
+For installation you will need to install `node` and `npm`, if you don't already have it. `node` and `npm` can be installed from [here](https://nodejs.org/en/download/).
+
+To install the project, simply run `npm install` in the project folder in the terminal on Mac or Command Prompt on Windows.
+
+## 🚀 Local Development
+
+To start the project locally:
+
+```bash
+npm run dev
+```
+
+This is run the app in development mode. Open [http://localhost:3000/](http://localhost:3000/) to view it in the browser.
+
+The page will reload if you make edits. You will also see any lint errors in the console.
+
+## 📜 Available Scripts
+
+- `npm run dev`: Executes `next dev` and start the local server for local deployment.
+- `npm run build`: Executes `next build` and builds the app for production and deployment.
+- `npm run preview`: Executes `next start` and serves the static build output locally.
+- `npm run clean`: Executes `rimraf node_modules && rimraf .next && rimraf package-lock.json` and remove node_modules folder, dist folder and package-lock.json.
+- `npm run lint`: Executes `npx eslint --fix && npx prettier . --write` and resolve all the linting and prettier errors.
+
+## 🧰 Tooling Setup
+
+This project uses ESLint integrated with Prettier to automatically format and lint your code.
+
+If you’re using Visual Studio Code, install:
+* [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+* [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+Your editor should now show linting errors and automatically fix issues where possible.
+
+More info: [ESLint Integrations](http://eslint.org/docs/user-guide/integrations)
+
+## 🎨 Styling
+
+This project uses [Tailwind CSS](https://tailwindcss.com/) for styling and and includes pre-configured design tokens from the UNDP Design System.
+
+## 🛡️ Authentication
+
+Authentication in this project is powered by [Better Auth](https://www.better-auth.com/), which provides a simple and flexible API for adding new providers.
+
+**Add a new provider**
+Add a new provider in `lib/auth.ts`. For example to add Google authenticator:
+
+```ts
+import { betterAuth } from 'better-auth';
+import { nextCookies } from 'better-auth/next-js';
+
+export const auth = betterAuth({
+  plugins: [nextCookies()],
+  secret: process.env.BETTER_AUTH_SECRET,
+  baseURL: process.env.BETTER_AUTH_URL,
+  session: {
+    strategy: 'jwt',
+    expiresIn: 60 * 60 * 24 * 7,
+    cookieCache: {
+      enabled: true,
+      maxAge: 60 * 60 * 24 * 7,
+    },
+  },
+  emailAndPassword: {
+    enabled: false,
+  },
+  socialProviders: {
+    goggle: {
+      clientId: process.env.GITHUB_CLIENT_ID as string,
+      clientSecret: process.env.GITHUB_CLIENT_SECRET as string,
+    },
+  },
+});
+```
+
+**Add env variable**
+Add client id and secret (and tenant id) in the `.env.local` file. These id and secret are used in `lib/auth.ts`.
+
+**Add a sign in button**
+Example of sign in button
+
+```ts
+import { signIn } from '@/lib/auth-client';
+
+<button onClick={() => signIn.social({ provider: 'google', callbackURL: '/user' })}>
+  Sign in with Google
+</button>
+```
+
+More info: [Better Auth docs](https://www.better-auth.com/docs/introduction)
+
+## 📬 Contact us
+
+For questions or feedback, contact us at [data@undp.org](mailto:data@undp.org).

package/bin/templates/next/withDataViz/auth/app/about/page.tsx

@@ -0,0 +1,33 @@
+'use client';
+
+import { H6, P } from '@undp/design-system-react/Typography';
+import Image from 'next/image';
+
+export default function Home() {
+  return (
+    <>
+      <div className='flex gap-4 items-center justify-center my-8 mx-auto'>
+        <Image
+          className='dark:invert'
+          src='/next.svg'
+          alt='Next.js logo'
+          width={100}
+          height={20}
+          priority
+        />
+        <P marginBottom='none'>&</P>
+        <Image
+          className='dark:invert'
+          src='/undp-logo-blue.svg'
+          alt='UNDP logo'
+          width={40}
+          height={20}
+          priority
+        />
+      </div>
+      <H6 marginBottom='xl' className='text-center'>
+        This is the about page.
+      </H6>
+    </>
+  );
+}

package/bin/templates/next/withDataViz/auth/app/api/auth/[...all]/route.ts

@@ -0,0 +1,5 @@
+import { toNextJsHandler } from 'better-auth/next-js';
+
+import { auth } from '@/lib/auth';
+
+export const { GET, POST } = toNextJsHandler(auth.handler);

package/bin/templates/next/withDataViz/auth/app/globals.css

@@ -0,0 +1,3 @@
+@import "tailwindcss";
+
+@config "../tailwind.config.js";

package/bin/templates/next/withDataViz/auth/app/layout.tsx

@@ -0,0 +1,30 @@
+import type { Metadata } from 'next';
+
+import HeaderEl from '@/components/Header';
+import FooterEl from '@/components/Footer';
+
+import './globals.css';
+import '@undp/design-system-react/style.css';
+
+export const metadata: Metadata = {
+  title: 'My Next + UNDP app',
+  description: 'Generated by create undp app',
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang='en'>
+      <body className='flex flex-col gap-0 min-h-screen'>
+        <HeaderEl />
+        <main className='grow-1 flex flex-col justify-center'>
+          <div className='flex flex-col justify-center'>{children}</div>
+        </main>
+        <FooterEl />
+      </body>
+    </html>
+  );
+}

package/bin/templates/next/withDataViz/auth/app/login/page.tsx

@@ -0,0 +1,45 @@
+'use client';
+
+import Image from 'next/image';
+import { P } from '@undp/design-system-react/Typography';
+import { Button } from '@undp/design-system-react/Button';
+
+import { signIn } from '@/lib/auth-client';
+
+export default function LoginPage() {
+  const handleSignIn = async () => {
+    await signIn.social({
+      provider: 'microsoft',
+      callbackURL: '/user',
+    });
+  };
+
+  return (
+    <>
+      <div className='flex gap-4 items-center justify-center my-8 mx-auto'>
+        <Image
+          className='dark:invert'
+          src='/next.svg'
+          alt='Next.js logo'
+          width={100}
+          height={20}
+          priority
+        />
+        <P marginBottom='none'>&</P>
+        <Image
+          className='dark:invert'
+          src='/undp-logo-blue.svg'
+          alt='UNDP logo'
+          width={40}
+          height={20}
+          priority
+        />
+      </div>
+      <div className='flex justify-center'>
+        <Button onClick={handleSignIn} variant='tertiary'>
+          Sign in with Microsoft
+        </Button>
+      </div>
+    </>
+  );
+}

package/bin/templates/next/withDataViz/auth/app/page.tsx

@@ -0,0 +1,33 @@
+'use client';
+
+import { H6, P } from '@undp/design-system-react/Typography';
+import Image from 'next/image';
+
+export default function Home() {
+  return (
+    <>
+      <div className='flex gap-4 items-center justify-center my-8 mx-auto'>
+        <Image
+          className='dark:invert'
+          src='/next.svg'
+          alt='Next.js logo'
+          width={100}
+          height={20}
+          priority
+        />
+        <P marginBottom='none'>&</P>
+        <Image
+          className='dark:invert'
+          src='/undp-logo-blue.svg'
+          alt='UNDP logo'
+          width={40}
+          height={20}
+          priority
+        />
+      </div>
+      <H6 marginBottom='xl' className='text-center'>
+        To get started, edit the page.tsx file.
+      </H6>
+    </>
+  );
+}

package/bin/templates/next/withDataViz/auth/app/user/page.tsx

@@ -0,0 +1,86 @@
+'use client';
+
+import Image from 'next/image';
+import { Spinner } from '@undp/design-system-react/Spinner';
+import { H6, P } from '@undp/design-system-react/Typography';
+import { Button } from '@undp/design-system-react/Button';
+
+import { useSession, signIn } from '@/lib/auth-client';
+
+export default function UserPage() {
+  const { data: session, isPending } = useSession();
+
+  if (isPending) {
+    return (
+      <div className='my-8 mx-aut'>
+        <Spinner />
+      </div>
+    );
+  }
+  const handleSignIn = async () => {
+    await signIn.social({
+      provider: 'microsoft',
+      callbackURL: '/user',
+    });
+  };
+
+  if (!session)
+    return (
+      <>
+        <div className='flex gap-4 items-center justify-center my-8 mx-auto'>
+          <Image
+            className='dark:invert'
+            src='/next.svg'
+            alt='Next.js logo'
+            width={100}
+            height={20}
+            priority
+          />
+          <P marginBottom='none'>&</P>
+          <Image
+            className='dark:invert'
+            src='/undp-logo-blue.svg'
+            alt='UNDP logo'
+            width={40}
+            height={20}
+            priority
+          />
+        </div>
+        <H6 marginBottom='xl' className='text-center'>
+          Please sign in to view this page
+        </H6>
+        <div className='flex justify-center'>
+          <Button variant='tertiary' onClick={handleSignIn}>
+            Sign In
+          </Button>
+        </div>
+      </>
+    );
+
+  return (
+    <>
+      <div className='flex gap-4 items-center justify-center my-8 mx-auto'>
+        <Image
+          className='dark:invert'
+          src='/next.svg'
+          alt='Next.js logo'
+          width={100}
+          height={20}
+          priority
+        />
+        <P marginBottom='none'>&</P>
+        <Image
+          className='dark:invert'
+          src='/undp-logo-blue.svg'
+          alt='UNDP logo'
+          width={40}
+          height={20}
+          priority
+        />
+      </div>
+      <H6 marginBottom='xl' className='text-center'>
+        Welcome, {session.user.name || session.user.email}!
+      </H6>
+    </>
+  );
+}

package/bin/templates/next/withDataViz/auth/components/Footer.tsx

@@ -0,0 +1,16 @@
+'use client';
+
+import {
+  Footer,
+  FooterLogoUnit,
+  FooterCopyrightUnit,
+} from '@undp/design-system-react/Footer';
+
+export default function FooterEl() {
+  return (
+    <Footer>
+      <FooterLogoUnit>subscribe to email</FooterLogoUnit>
+      <FooterCopyrightUnit>Footnote can be added here</FooterCopyrightUnit>
+    </Footer>
+  );
+}

package/bin/templates/next/withDataViz/auth/components/Header.tsx

@@ -0,0 +1,56 @@
+'use client';
+
+import {
+  Header,
+  HeaderActions,
+  HeaderLogoUnit,
+  HeaderMainNavUnit,
+  HeaderMenuUnit,
+} from '@undp/design-system-react/Header';
+import Link from 'next/link';
+import { Spinner } from '@undp/design-system-react';
+import { Button } from '@undp/design-system-react/Button';
+
+import { signIn, useSession, signOut } from '@/lib/auth-client';
+
+export default function HeaderEl() {
+  const { data: session, isPending } = useSession();
+  const handleSignIn = async () => {
+    await signIn.social({
+      provider: 'microsoft',
+      callbackURL: window.location.href,
+    });
+  };
+  const handleSignOut = async () => {
+    await signOut();
+  };
+  return (
+    <Header>
+      <HeaderLogoUnit
+        hyperlink='./'
+        siteName='Site name'
+        siteSubName='Sub-site name'
+      />
+      <HeaderMainNavUnit>
+        <HeaderMenuUnit>
+          <Link href='/'>Home</Link>
+          <Link href='/about'>About</Link>
+          <Link href='/user'>User</Link>
+        </HeaderMenuUnit>
+        <HeaderActions>
+          {isPending ? (
+            <Spinner />
+          ) : session ? (
+            <Button variant='tertiary' onClick={handleSignOut}>
+              Sign Out
+            </Button>
+          ) : (
+            <Button variant='tertiary' onClick={handleSignIn}>
+              Sign In
+            </Button>
+          )}
+        </HeaderActions>
+      </HeaderMainNavUnit>
+    </Header>
+  );
+}

package/bin/templates/next/withDataViz/auth/eslint.config.mjs

@@ -0,0 +1,103 @@
+import nextVitals from 'eslint-config-next/core-web-vitals';
+import nextTs from 'eslint-config-next/typescript';
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import pluginReact from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import importPlugin from 'eslint-plugin-import';
+import { defineConfig } from 'eslint/config';
+import prettierConfig from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+export default defineConfig([
+  {
+    ignores: [
+      'node_modules/**',
+      'build/**',
+      'public/**',
+      'dist/**',
+      'storybook-static/**',
+      'dist-ssr/**',
+      'coverage/**',
+      '**/*.test.js',
+      '**/__snapshots__/**',
+      '.next/**',
+      'out/**',
+      'next-env.d.ts',
+    ],
+  },
+  ...nextVitals,
+  ...nextTs,
+  js.configs.recommended,
+  reactHooks.configs.flat.recommended,
+  ...tseslint.configs.recommended,
+  {
+    files: ['**/*.{js,mjs,cjs,ts,jsx,tsx,ts}'],
+    plugins: {
+      react: pluginReact,
+      'react-hooks': reactHooks,
+      import: importPlugin,
+      prettier: prettierPlugin,
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+    rules: {
+      // React rules
+      'react/self-closing-comp': ['error', { component: true, html: true }],
+      'react/react-in-jsx-scope': 'off',
+      'react/jsx-uses-react': 'off',
+      'react/jsx-uses-vars': 'warn',
+      'react/jsx-no-undef': 'error',
+      'react/jsx-curly-brace-presence': 'error',
+      'react/prop-types': 'off',
+      'react/require-default-props': 0,
+      'react/jsx-filename-extension': 0,
+      'react/no-array-index-key': 0,
+      'react/jsx-props-no-spreading': 0,
+
+      // TypeScript rules
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_' },
+      ],
+      '@typescript-eslint/no-explicit-any': 'warn',
+
+      // Import rules
+      'import/order': [
+        'warn',
+        {
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            'sibling',
+            'index',
+          ],
+          'newlines-between': 'always',
+        },
+      ],
+      'import/no-unresolved': 0,
+      'import/no-extraneous-dependencies': ['warn', { devDependencies: true }],
+      'import/extensions': 0,
+      'import/prefer-default-export': 0,
+      'import/no-anonymous-default-export': 0,
+
+      // A11y rules
+      'jsx-a11y/alt-text': 'warn',
+      'jsx-a11y/anchor-is-valid': 'warn',
+
+      // General rules
+      'prefer-const': 'error',
+      'no-console': ['warn', { allow: ['warn', 'error'] }],
+      'no-debugger': 'warn',
+      'no-nested-ternary': 0,
+      'prettier/prettier': 'error',
+    },
+  },
+  prettierConfig,
+]);

package/bin/templates/next/withDataViz/auth/lib/auth-client.ts

@@ -0,0 +1,7 @@
+import { createAuthClient } from 'better-auth/react';
+
+export const authClient = createAuthClient({
+  baseURL: process.env.NEXT_PUBLIC_BETTER_AUTH_URL || 'http://localhost:3000',
+});
+
+export const { signIn, signOut, useSession } = authClient;

package/bin/templates/next/withDataViz/auth/lib/auth.ts

@@ -0,0 +1,30 @@
+import { betterAuth } from 'better-auth';
+import { nextCookies } from 'better-auth/next-js';
+
+export const auth = betterAuth({
+  plugins: [nextCookies()],
+  secret: process.env.BETTER_AUTH_SECRET,
+  baseURL: process.env.BETTER_AUTH_URL,
+  session: {
+    strategy: 'jwt',
+    expiresIn: 60 * 60 * 24 * 7,
+    cookieCache: {
+      enabled: true,
+      maxAge: 60 * 60 * 24 * 7,
+    },
+  },
+  emailAndPassword: {
+    enabled: false,
+  },
+  socialProviders: {
+    github: {
+      clientId: process.env.GITHUB_CLIENT_ID as string,
+      clientSecret: process.env.GITHUB_CLIENT_SECRET as string,
+    },
+    microsoft: {
+      clientId: process.env.AZURE_CLIENT_ID as string,
+      clientSecret: process.env.AZURE_CLIENT_SECRET as string,
+      tenantId: process.env.AZURE_TENANT_ID as string,
+    },
+  },
+});

package/bin/templates/next/withDataViz/auth/next.config.ts

@@ -0,0 +1,10 @@
+import type { NextConfig } from 'next';
+
+const nextConfig: NextConfig = {
+  /* config options here */
+  env: {
+    NEXT_PUBLIC_BETTER_AUTH_URL: process.env.BETTER_AUTH_URL,
+  },
+};
+
+export default nextConfig;

package/bin/templates/next/withDataViz/auth/postcss.config.mjs

@@ -0,0 +1,7 @@
+const config = {
+  plugins: {
+    '@tailwindcss/postcss': {},
+  },
+};
+
+export default config;

package/bin/templates/next/withDataViz/auth/public/next.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

package/bin/templates/next/withDataViz/auth/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts",
+    "**/*.mts"
+  ],
+  "exclude": ["node_modules"]
+}

package/bin/templates/next/withDataViz/basic/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "avoid",
+  "tabWidth": 2,
+  "jsxSingleQuote": true,
+  "endOfLine": "auto",
+  "bracketSpacing": true
+}