Zavi Family

This is a monorepo containing all applications under zavi.family domain, built using Turborepo.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

• docs: a Next.js app for documenting the technologies used in this monorepo. It will be built based on Tailwind UI's Syntax documentation template.
• homeschool: a Next.js app for tracking homeschooling activities and viewing the reports. It will be my first experiment building Static Apps using React Server Components in Next.js.
• homeschooling: a Remix app for tracking homeschooling activities and viewing the reports. It will be an alternative implementation if the homeschool Next.js app doesn't perform as well as promised.
• ui: a React component library shared by all applications under the apps directory, eventually will be populated by shadcn/ui components.
• eslint-config-custom: eslint configurations (includes eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Prerequisites

This repository uses pnpm package manager, so ensure that you have it installen in your system.

After cloning the repository, ensure that you install all dependencies by running this command:

pnpm i

Build

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

pnpm build

Develop

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

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:

pnpm dlx 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:

pnpm dlx turbo link

Useful Links

Learn more about the power of Turborepo:

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