Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 5 KB

README.md

File metadata and controls

111 lines (80 loc) · 5 KB
Raw

Single Page Application starter

This is a suggested stack to build modern SPA.
It's hosted here : https://vite-insee-starter.demo-domain.ovh/

It's composed of:

  • Docker
  • Nginx
  • Vite
  • TypeScript
  • React
  • Tanstack Router - A better alternative to React Router.
  • 🐓 react-dsfr - The React Toolkit for The French Design System (DSFR)
  • MUI - As a backup component library to fallback to if you don't find the component you need in the DSFR library.
  • 🐓 vite-envs - A solution to avoid having to re-build the app when you change the environment variables.
  • 🐓 tss-react - A CSS-in-JS solution.
  • 🐓 i18nifty - A solution to to make your app available in multiple languages.
  • react-query - A solution to manage your API calls.
  • 🐓 oidc-spa - A solution to integrate OpenID Connect in your app. (Keycloak)
  • 🐓 tsafe - Type safety utilities.
  • 🐓 ts-ci - GitHub Actions to manage the lifecycle of the project and publish automatically on Docker Hub.
  • Prettier - Code formatter.
  • Orval - A solution to generate API clients based on OpenAPI specs.

🐓: Made by us.

Running locally

git clone https://github.com/InseeFrLab/vite-insee-starter
cd vite-insee-starter
cp .env.sample .env.local
yarn
yarn dev

Deploying the APP

You can use the Docker Image published here: https://hub.docker.com/r/inseefrlab/vite-insee-starter
You have to set the environment variables:

VITE_API_URL=https://insee-todo-api.up.railway.app
VITE_OIDC_ISSUER=https://auth.code.gouv.fr/auth/realms/playground
VITE_OIDC_CLIENT_ID=vite-insee-starter

Automatic publishing on Docker Hub

The CI of this starter automatically publishes on dockerhub under <name of the github org>/<name of the repo>

For it to work you must have set the GitHub Actions secrets:

${{ secrets.DOCKERHUB_USERNAME }}
${{ secrets.DOCKERHUB_TOKEN }}

(It is configured in the option of the repo or the github org)

The TODO rest API

For demoing this stack we created a simple todo app REST API.
It's available here: https://github.com/InseeFrLab/todo-rest-api and is deployed here: https://insee-todo-api.up.railway.app/doc

The client used to consume this API is automatically generated by Orval.
You can refresh it for the currently published version of the API by running:

yarn generate-todos-api-client

Keycloak theme

When authenticating you will notice that the login pages are DSFR themed.
We're using the custom keycloak theme of the DSFR: keycloak-theme-dsfr 🐓.
It has been created using react-dsfr and Keycloakify.

Build with this stack:

Onyxia

image

The French Interministeriel Base of Free Software

image

Why pushing tss-react over other styling solution?

You might think that tss-react isn't the more obvious choice and I'm just pushing it because we made it but here me out.
It has approximately 900 000 downloads per month and is used by establish solution like Jitsi and it integrates flawlessly with MUI. It's even mentioned in the official MUI documentation.

But more importantly. It's arguably the one of the most powerful styling solution. It enables to write styles as a function of the internal state of the component.
It let you express sophisticated styling logic in a way that is easy to read and maintain.

It's drawback is that, as it's a dynamic styling solution (as opposed to statically extracted ones like tailwind), it's doesn't have the same performance and is not compatible with Next.js Server Components. However at Insee we're building SPA and the performance hit is negligible (we're talking about a few milliseconds).