ZURIMAIN

This is an official Yarn v1 starter turborepo.

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps and Packages

• apps/core: a single-spa microfrontend this houses most of zurimain's ui
• packages/root-config: a single-spa rootconfig this is the zurimain wrapper and is what binds all packages and plugins
• packages/sidebar: a react application that houses the sidebar and navigation controls
• packages/utilities: a library housing essential helper functions used by all plugins
• packages/ui: a stub React component library shared by both core application and all plugins
• packages/eslint-config-custom: eslint configurations (includes eslint-config-prettier)
• packages/tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Getting Started.

Make sure you have nodejs installed by running the following command:

node -v

If the output is not the version of your nodejs installation, install nodejs from here

After installing nodejs install yarn if you have it then install the project's dependencies:

yarn install

Build

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

cd my-turborepo
yarn run build

To remove dist folder

yarn clean

To remove dist folder and all node_modules

yarn clean-fresh

Develop

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

cd my-turborepo
yarn run dev

Open http://localhost:9000 with your browser to see the result.

Contributing

For detailed information on how to go about contributing to this project. Check out the

• Contribution Guide
• Styling Guide

Before send PR or making a merge make sure you code is properly formatted. You can easily do that by running

yarn lint # to lint all files # in project directory
yarn lint:js # to lint only js,jsx files # in project directory

yarn prettify # to prettify files # in project directory

you can also lint for all files in the repo by running that command in the root folder.

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:

• Pipelines
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage