This is a Create-Remix Template for a Frontend Monorepo. (Create-Remix is only used to generate the initial project structure, the project itself does not use Remix.)
It puts emphasis on rapid prototyping and a prototype-driven development (Pixar Planning).
This monorepo contains the following packages/apps:
- A prototype for the application, based on React Router SPA.
- A package that provides the domain types and enums.
- A documentation in Antora (AsciiDoc) format.
- A package that provides synthetic data for the applications using Faker.js.
- A package that provides a mock API via service workers using MSW.
- A component library that is shared by the main application and the prototype.
- ESLint and TypeScript configurations that are shared throughout the monorepo.
- Monorepo based on ESM standards.
- Turborepo for building and running the monorepo.
- Pre-Configured CI Pipeline for Gitlab CI.
- Continuous deployment for the prototype and preview environments for merge-requests.
- Automatic deployment of the documentation to Gitlab Pages.
- Code formatting with Prettier and linting with ESLint.
Each package/app is written in TypeScript.
The prototype is automatically deployed to a preview server on a push to the main
branch or a
tagged commit.
The developer documentation is located in the docs
folder. It is automatically published via
Gitlab Pages.
The project documentation is written in AsciiDoc and is generated using Antora.
To get started, run the following command:
npx create-remix@latest --template ti8m/tinker-stack