@undp/create-app 0.1.1 → 0.2.0

package/bin/generateTemplates/copyTemplate.js

@@ -1,18 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-function getTemplatePath(filename, folders) {
-  const __filename = fileURLToPath(import.meta.url);
-  const __dirname = path.dirname(__filename);
-  return path.join(
-    __dirname,
-    ...folders,
-    filename
-  );
-}
-
-export function copyTemplate(destination, filename, folders) {
-  const content = fs.readFileSync(getTemplatePath(filename, folders), 'utf-8');
-  fs.writeFileSync(destination, content);
-}

package/bin/generateTemplates/generatePackageJson.js

@@ -1,105 +0,0 @@
-import { execSync } from 'child_process';
-import chalk from 'chalk';
-
-function getLatestVersion(pkg) {
-  console.log(chalk.gray(`  Fetching latest version for ${pkg}`));
-  try {
-    return execSync(`npm show ${pkg} version`).toString().trim();
-  } catch {
-    return 'latest';
-  }
-}
-
-export function generatePackageJson(config) {
-  const DEPENDENCIES = ['@undp/design-system-react', 'react', 'react-dom'] 
-  if(config.installLucide) DEPENDENCIES.push('lucide-react');
-  if(config.installDataViz) DEPENDENCIES.push('@undp/data-viz');
-  if(config.installQuery) DEPENDENCIES.push('@tanstack/react-query');
-  if(config.installRouter) DEPENDENCIES.push('@tanstack/react-router');
-  const dependencies = {};
-  DEPENDENCIES.forEach((d) => {
-    const version = getLatestVersion(d)
-    dependencies[d] = version === 'latest' ? 'latest' : `^${version}`;
-  })
-  const PEER_DEPENDENCIES = config.installDataVizPeerDeps ? [
-    '@dnd-kit/core',
-    '@dnd-kit/modifiers',
-    'ajv',
-    'dom-to-svg',
-    'file-saver',
-    'handlebars',
-    'maplibre-gl',
-    'marked',
-    'math-expression-evaluator',
-    'pmtiles',
-    'react-globe.gl',
-    'three',
-  ] : [];
-  PEER_DEPENDENCIES.forEach((d) => {
-    const version = getLatestVersion(d)
-    dependencies[d] = version === 'latest' ? 'latest' : `^${version}`;
-  })
-  const DEV_DEPENDENCIES = [
-    '@eslint/config-array',
-    '@eslint/js',
-    '@nabla/vite-plugin-eslint',
-    '@tailwindcss/postcss',
-    '@tailwindcss/vite',
-    '@types/node',
-    '@types/react',
-    '@types/react-dom',
-    '@vitejs/plugin-react',
-    'autoprefixer',
-    'babel-plugin-react-compiler',
-    'eslint',
-    'eslint-config-love',
-    'eslint-config-prettier',
-    'eslint-plugin-import',
-    'eslint-plugin-jsx-a11y',
-    'eslint-plugin-n',
-    'eslint-plugin-prettier',
-    'eslint-plugin-promise',
-    'eslint-plugin-react',
-    'eslint-plugin-react-hooks',
-    'postcss',
-    'postcss-nested',
-    'prettier',
-    'rimraf',
-    'rollup-plugin-visualizer',
-    'tailwind-animate',
-    'tailwind-merge',
-    'tailwindcss',
-    'tailwindcss-animate',
-    'typescript',
-    'typescript-eslint',
-    'vite',
-    'vite-plugin-static-copy',
-  ]
-  const devDependencies = {}
-  DEV_DEPENDENCIES.forEach((d) => {
-    const version = getLatestVersion(d)
-    devDependencies[d] = version === 'latest' ? 'latest' : `^${version}`;
-  })
-  const packageJson = {
-    name: config.projectName,
-    private: true,
-    version: '0.0.0',
-    type: 'module',
-    keywords: [],
-    author: '',
-    sideEffects: [
-      '*.css'
-    ],
-    scripts: {
-      dev: 'vite',
-      build: 'tsc && vite build',
-      preview: 'vite preview',
-      clean: 'rimraf node_modules && rimraf dist && rimraf package-lock.json',
-      'install:build': 'npm install && tsc && vite build',
-      lint: 'npx eslint --fix && npx prettier . --write'
-    },
-    dependencies: dependencies,
-    devDependencies: devDependencies
-  }
-  return packageJson
-}

package/bin/generateTemplates/generateReadme.js

@@ -1,143 +0,0 @@
-export function generateReadme(config){
-  return `# ${config.projectName}
-
-React + TypeScript + Vite project with Tailwind CSS ${config.installDataViz ? ', UNDP Design System and data viz library' : 'and UNDP Design System'}.
-
-This is a template to initiate project with tooling for linting and prettier and uses React Compiler.
-
-## Installed Libraries
-
-- React 19.2
-- @undp/design-system-react${config.installLucide ? '\n- lucide-react' : ''}${config.installDataViz ? '\n- @undp/data-viz' : ''}${config.installQuery ? '\n- @tanstack/react-query' : ''}${config.installRouter ? '\n- @tanstack/react-router' : ''}
-
-## 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 clone the the repo and them run \`npm install\` in the project folder. You can use terminal on Mac and Command Prompt on Windows.
-
-This project is bootstrapped with [\`Vite\`](https://vitejs.dev/) and was created using \`npm create vite@latest\` command.
-
-Run the terminal or command prompt and then run the following
-
-\`\`\`
-git clone https://github.com/UNDP-Data/${config.projectName}.git
-cd ${config.projectName}
-npm install
-\`\`\`
-
-## Local Development
-
-To start the project locally, you can run \`npm run dev\` in the project folder in terminal or command prompt.
-
-This is run the app in development mode. Open [http://localhost:5173/](http://localhost:5173/) 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 \`vite\` and start the local server for local deployment.
-- \`npm run build\`: Executes \`tsc && vite build\` and builds the app for production and deployment.
-- \`npm run clean\`: Executes \`rimraf node_modules && rimraf dist && 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, which verifies and formats your code so you don't have to do it manually. You should have your editor set up to display lint errors and automatically fix those which it is possible to fix. See [http://eslint.org/docs/user-guide/integrations](http://eslint.org/docs/user-guide/integrations).
-
-This project is build in Visual Studio Code, therefore the project is already set up to work with. Install it from [here](https://code.visualstudio.com/) and then install this [eslint plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and you should be good to go.
-
-## Styling
-
-This project uses [Tailwind CSS](https://tailwindcss.com/) for styling.
-
-${
-  config.installRouter ? `## Routing
-
-This project uses [TanStack Router](https://tanstack.com/router). The initial setup is a code based router. Which means that the routes are defined in code (in the \`./src/main.tsx\` file).
-
-### Adding A Route
-
-To add a new route to your application just add another \`createRoute\` call to the \`./src/main.tsx\` file. The example below adds a new \`/about\`route to the root route.
-
-\`\`\`tsx
-const aboutRoute = createRoute({
-  getParentRoute: () => rootRoute,
-  path: "/about",
-  component: () => <h1>About</h1>,
-});
-\`\`\`
-
-You will also need to add the route to the \`routeTree\` in the \`./src/main.tsx\` file.
-
-\`\`\`tsx
-const routeTree = rootRoute.addChildren([indexRoute, aboutRoute]);
-\`\`\`
-
-With this set up you should be able to navigate to \`/about\` and see the about page.
-
-Of course you don't need to implement the About page in the \`main.tsx\` file. You can create that component in another file and import it into the \`main.tsx\` file, then use it in the \`component\` property of the \`createRoute\` call, like so:
-
-\`\`\`tsx
-import About from "./components/About.tsx";
-
-const aboutRoute = createRoute({
-  getParentRoute: () => rootRoute,
-  path: "/about",
-  component: About,
-});
-\`\`\`
-
-That is how we have the \`App\` component set up with the home page.
-
-For more information on the options you have when you are creating code based routes check out the [Code Based Routing](https://tanstack.com/router/latest/docs/framework/react/guide/code-based-routing) documentation.
-
-Now that you have two routes you can use a \`Link\` component to navigate between them.
-
-### Adding Links
-
-To use SPA (Single Page Application) navigation you will need to import the \`Link\` component from \`@tanstack/react-router\`.
-
-\`\`\`tsx
-import { Link } from "@tanstack/react-router";
-\`\`\`
-
-Then anywhere in your JSX you can use it like so:
-
-\`\`\`tsx
-<Link to="/about">About</Link>
-\`\`\`
-
-This will create a link that will navigate to the \`/about\` route.
-
-More information on the \`Link\` component can be found in the [Link documentation](https://tanstack.com/router/v1/docs/framework/react/api/router/linkComponent).
-` :''
-}
-${
-  config.installQuery ? `## Query
-
-This project uses [TanStack Query](https://tanstack.com/query).
-` :''
-}
-## Steps to Embed
-
-Add the following div in the page
-
-\`\`\`
-<div id="root"></div>
-\`\`\`
-
-Apart from the mentioned \`div\` above the following \`script\` and \`link\` needs to be added to the \`head\` or in the embed code
-
-\`\`\`
-<link rel="dns-prefetch" href="{{Link to the Visualization}}">
-<script defer="defer" type="module" src="{{Link to the Visualization}}/index.js"></script>
-<link rel="modulepreload" crossorigin href="{{Link to the Visualization}}/react-{{hash}}.js">
-<link rel="modulepreload" crossorigin href="{{Link to the Visualization}}/undp-{{hash}}.js">
-<link rel="stylesheet" href="{{Link to the Visualization}}/style.css"></link>
-\`\`\`
-
-# Contact us
-Contact us at [data@undp.org](mailto:data@undp.org) if you have any feedback or questions.
-`;
-}

package/bin/generateTemplates/generateStyleCss.js

@@ -1,6 +0,0 @@
-export function generateStyleCss(installDataViz){
-  return `@import '@undp/design-system-react/style.css';
-${installDataViz ? `@import '@undp/data-viz/style.css';` : ''}
-@import 'tailwindcss';
-@config '../../tailwind.config.js';`;
-}

package/bin/generateTemplates/index.js

@@ -1,6 +0,0 @@
-
-export { copyTemplate } from './copyTemplate.js';
-export { generateIndexHtml } from './generateIndexHtml.js';
-export { generatePackageJson } from './generatePackageJson.js';
-export { generateReadme } from './generateReadme.js';
-export { generateStyleCss } from './generateStyleCss.js';

package/bin/generateTemplates/templates/basic/App.txt

@@ -1,32 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function App() {
-  return (
-    <div>
-      <div className='m-5'>
-        <div>
-          <img
-            src={undpLogo}
-            className='logo react mb-8'
-            alt='React logo'
-            width='72px'
-            style={{ marginLeft: 'auto', marginRight: 'auto' }}
-          />
-        </div>
-        <H3 className='text-center'>
-          This is template for building visualization and frontend project
-          maintained by UNDP&apos;s DAI Hub.
-          <br />
-          <br />
-          Contact us at data@undp.org if you have any feedback or questions.
-        </H3>
-      </div>
-    </div>
-  );
-}
-
-export default App;

package/bin/generateTemplates/templates/basic/AppWithContainer.txt

@@ -1,32 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function App() {
-  return (
-    <div className='undp-container'>
-      <div className='m-5'>
-        <div>
-          <img
-            src={undpLogo}
-            className='logo react mb-8'
-            alt='React logo'
-            width='72px'
-            style={{ marginLeft: 'auto', marginRight: 'auto' }}
-          />
-        </div>
-        <H3 className='text-center'>
-          This is template for building visualization and frontend project
-          maintained by UNDP&apos;s DAI Hub.
-          <br />
-          <br />
-          Contact us at data@undp.org if you have any feedback or questions.
-        </H3>
-      </div>
-    </div>
-  );
-}
-
-export default App;

package/bin/generateTemplates/templates/configFiles/staticwebapp.config.json

@@ -1,44 +0,0 @@
-{
-  "globalHeaders": {
-    "Access-Control-Allow-Origin": "*",
-    "Access-Control-Allow-Methods": "GET, OPTIONS"
-  },
-  "routes": [
-    {
-      "route": "/react-*.js",
-      "headers": {
-        "Access-Control-Allow-Origin": "*",
-        "Access-Control-Allow-Methods": "GET, OPTIONS",
-        "Cache-Control": "public, max-age=31536000, immutable"
-      }
-    },
-    {
-      "route": "/undp-*.js",
-      "headers": {
-        "Access-Control-Allow-Origin": "*",
-        "Access-Control-Allow-Methods": "GET, OPTIONS",
-        "Cache-Control": "public, max-age=31536000, immutable"
-      }
-    },
-    {
-      "route": "/index.js",
-      "headers": {
-        "Access-Control-Allow-Origin": "*",
-        "Access-Control-Allow-Methods": "GET, OPTIONS",
-        "Cache-Control": "no-cache"
-      }
-    },
-    {
-      "route": "/*",
-      "headers": {
-        "Access-Control-Allow-Origin": "*",
-        "Access-Control-Allow-Methods": "GET, OPTIONS",
-        "Cache-Control": "no-cache"
-      }
-    }
-  ],
-  "navigationFallback": {
-    "rewrite": "/index.html",
-    "exclude": ["/assets/*", "/*.js", "/*.css", "/*.png", "/*.jpg", "/*.svg"]
-  }
-}

package/bin/generateTemplates/templates/configFiles/vite-env.txt

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/bin/generateTemplates/templates/query/App.txt

@@ -1,57 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-import { useQuery } from '@tanstack/react-query';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function useTodoData() {
-  return useQuery({
-    queryKey: ['todos'],
-    queryFn: () =>
-      Promise.resolve([
-        { id: 1, name: 'Alice' },
-        { id: 2, name: 'Bob' },
-        { id: 3, name: 'Charlie' },
-      ]),
-    initialData: [],
-  });
-}
-
-function App() {
-  const { data, isLoading, isError } = useTodoData();
-
-  if (isLoading) return <Spinner size='lg' className='my-20 m-auto' />;
-
-  if (isError)
-    return (
-      <div className='px-4 mx-auto'>
-        <div>Error</div>
-      </div>
-    );
-  return (
-    <div className='m-5'>
-      <div>
-        <img
-          src={undpLogo}
-          className='logo react mb-8'
-          alt='React logo'
-          width='72px'
-          style={{ marginLeft: 'auto', marginRight: 'auto' }}
-        />
-      </div>
-      <H3 className='text-center'>
-        This is template for building visualization and frontend project
-        maintained by UNDP&apos;s DAI Hub.
-        <br />
-        <br />
-        Contact us at data@undp.org if you have any feedback or questions.
-        <br />
-        <br />
-        {data.length} elements in the query
-      </H3>
-    </div>
-  );
-}
-
-export default App;

package/bin/generateTemplates/templates/query/AppWithContainer.txt

@@ -1,67 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-import { useQuery } from '@tanstack/react-query';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function useTodoData() {
-  return useQuery({
-    queryKey: ['todos'],
-    queryFn: () =>
-      Promise.resolve([
-        { id: 1, name: 'Alice' },
-        { id: 2, name: 'Bob' },
-        { id: 3, name: 'Charlie' },
-      ]),
-    initialData: [],
-  });
-}
-
-function App() {
-  const { data, isLoading, isError } = useTodoData();
-
-  if (isLoading) 
-    return (
-      <div className='undp-container'>
-        <Spinner size='lg' className='my-20 m-auto' />
-      </div>
-    );
-
-  if (isError)
-    return (
-      <div className='undp-container'>
-        <div className='px-4 mx-auto'>
-          <div>Error</div>
-        </div>
-      </div>
-    );
-    
-  return (
-    <div className='undp-container'>
-      <div className='m-5'>
-        <div>
-          <img
-            src={undpLogo}
-            className='logo react mb-8'
-            alt='React logo'
-            width='72px'
-            style={{ marginLeft: 'auto', marginRight: 'auto' }}
-          />
-        </div>
-        <H3 className='text-center'>
-          This is template for building visualization and frontend project
-          maintained by UNDP&apos;s DAI Hub.
-          <br />
-          <br />
-          Contact us at data@undp.org if you have any feedback or questions.
-          <br />
-          <br />
-          {data.length} elements in the query
-        </H3>
-      </div>
-    </div>
-  );
-}
-
-export default App;

package/bin/generateTemplates/templates/query/main.txt

@@ -1,29 +0,0 @@
-import { StrictMode } from 'react';
-import ReactDOM from 'react-dom/client';
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-
-import './styles/fonts.css';
-import './styles/style.css';
-
-import App from './App';
-
-const queryClient = new QueryClient({
-  defaultOptions: {
-    queries: {
-      staleTime: 1000 * 60 * 60 * 24, // how long fetched data is considered “fresh” before it becomes “stale” 🡢 24 hrs
-      gcTime: 1000 * 60 * 60 * 24, // how long inactive (unused) query data stays in memory before being deleted 🡢 24 hrs
-    },
-  },
-});
-
-const rootElement = document.getElementById('app');
-if (rootElement && !rootElement.innerHTML) {
-  const root = ReactDOM.createRoot(rootElement);
-  root.render(
-    <StrictMode>
-      <QueryClientProvider client={queryClient}>
-        <App />
-      </QueryClientProvider>
-    </StrictMode>,
-  );
-}

package/bin/generateTemplates/templates/router/App.txt

@@ -1,30 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function App() {
-  return (
-    <div className='m-5'>
-      <div>
-        <img
-          src={undpLogo}
-          className='logo react mb-8'
-          alt='React logo'
-          width='72px'
-          style={{ marginLeft: 'auto', marginRight: 'auto' }}
-        />
-      </div>
-      <H3 className='text-center'>
-        This is template for building visualization and frontend project
-        maintained by UNDP&apos;s DAI Hub.
-        <br />
-        <br />
-        Contact us at data@undp.org if you have any feedback or questions.
-      </H3>
-    </div>
-  );
-}
-
-export default App;

package/bin/generateTemplates/templates/router/components/Footer.txt

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

package/bin/generateTemplates/templates/router/routes/About.txt

@@ -1,28 +0,0 @@
-import { createRoute } from '@tanstack/react-router';
-import type { RootRoute } from '@tanstack/react-router';
-
-function About() {
-  return (
-    <div className='m-5'>
-      <div>
-        <img
-          src={undpLogo}
-          className='logo react mb-8'
-          alt='React logo'
-          width='72px'
-          style={{ marginLeft: 'auto', marginRight: 'auto' }}
-        />
-      </div>
-      <H3 className='text-center'>
-        This is an about page
-      </H3>
-    </div>
-  );
-}
-
-export default (parentRoute: RootRoute) =>
-  createRoute({
-    path: '/about',
-    component: About,
-    getParentRoute: () => parentRoute,
-  });

package/bin/generateTemplates/templates/router+query/App.txt

@@ -1,30 +0,0 @@
-import { H3 } from '@undp/design-system-react';
-
-import '@/styles/fonts.css';
-import '@/styles/style.css';
-import undpLogo from './assets/undp-logo-blue.svg';
-
-function App() {
-  return (
-    <div className='m-5'>
-      <div>
-        <img
-          src={undpLogo}
-          className='logo react mb-8'
-          alt='React logo'
-          width='72px'
-          style={{ marginLeft: 'auto', marginRight: 'auto' }}
-        />
-      </div>
-      <H3 className='text-center'>
-        This is template for building visualization and frontend project
-        maintained by UNDP&apos;s DAI Hub.
-        <br />
-        <br />
-        Contact us at data@undp.org if you have any feedback or questions.
-      </H3>
-    </div>
-  );
-}
-
-export default App;