Skip to content

Latest commit

 

History

History

turbo-rspack-mf

README.md

Zephyr Cloud Starter

This is an official starter for Zephyr Cloud.

Using this example

Run the following command:

npx create-turbo@latest --example https://github.com/swalker326/ze-starter-turbo

Running this example

For zephyr, a couple things have to happen,

  • Publish the project to github (or any other git provider)
    • Public or private, we just care about the git history
  • The remote applications need to be built first, which is handled by turbo so all you have to do is:
turbo run build

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

Rspack Applications

  • host: An rspack application and also the host app
  • home: Another rspack application with module federation setup being consumed by the host
  • settings: A final rspack application used to highlight the routing (react router)
  • @repo/tailwind-config: global tailwind configurations
  • @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

Build

To build all apps and packages, run the following command:

cd my-turborepo
pnpm build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
pnpm dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo: