The base templates
The details, goals and specs we use to drive all the base templates across tech stacks, to ensure consistency and quality, and to provide solid foundations for you to build on.
Table of contents
Why?
We want to give you solid foundations to build on, to take your project from 0 to 100, through a well-crafted base template, with detailed documentation and architecture decisions.
The base template is the main mechanism by which the tech stacks are formulated — i.e. they’re the beating heart of the tech stacks.
They provide an opinionated full-stack starting point for building a Progressive Web App (PWA). Aiming to be lean and useful enough so you can hit the ground running and focus on stuff that matters. With enough room for you to extend as you need.
The goal is to make them opinionated and well-crafted, but with enough flexibility so you are free to use and customize it as you want — to build a prototype, an internal tool, a side project, or the next big thing.
Documentation
Each come with detailed README
and ARCHITECTURE
docs, to describe what you get, the different technologies, how they work together, how to set things up, design decisions, basic how-tos, and more.
Specs
Out of the box, each base template must come with:
- A monorepo structure, with first-class VSCode workspace support.
- Full local development (as much as possible within that tech stack).
- Linting, type checking, formatting and other developer experience goodies.
- Test suite(s) covering the frontend and backend.
- Continuous Integration (CI).
- Production deployment.
- Modern features from the tech stack components and services.
- Easy ability to share common code, types, etc. between the frontend and backend.
- A UI toolkit and basic theme.
- A basic layout and navigation.
- Static (ideally pre-rendered) website pages.
- Passwordless auth (login via email link).
- Ability to log out.
- Progressive Web App (PWA) set-up.
- Including a service worker for offline support.
- Including a manifest for installability.
- Including a notification for new versions.
- Detailed documentation and architecture decisions.
Note: some tech stacks may provide more capabilities out of the box, but these are the minimum requirements.