tokyo-monorepo
tokyo-monorepo copied to clipboard
Monorepo powered by Turborepo, NextJS, Supabase, TailwindCSS, Graphile-Workers
Tokyo Monorepo
Based from Turborepo starter
What's inside?
This monorepo uses Yarn as a package manager. It includes the following packages/apps:
Apps and Packages
Apps
-
next-app
: Boilerplate Next.js app -
web
: Another Next.js app -
workers
: Node app for background job queueing using graphile-workers
Packages
-
ui
: a stub React component library shared by bothweb
anddocs
applications -
ui-storybook
: storybook setup to allow component building/discoverability -
config
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
) -
tsconfig
:tsconfig.json
s used throughout the monorepo -
tw-config
: `shareable Tailwind config across multiple UI apps in the repo
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
- Jest test runner for all things JavaScript
- Prettier for code formatting
- TailwindCSS for UI styling
- Supabase as backend
Pre-requisites
Quickstart
- yarn
- yarn run dev - Run all projects
- yarn run storybook - Run UI storybook
Missing CSS files?
- yarn run build - To safely initialize all CSS file locally
- yarn run dev
Develop
- Start Supabase instance
cd db/main
supabase start
- Generating Types
yarn types
- Run Storybook
yarn storybook
- Run NextJS projects
yarn dev
Build
To build all apps and packages, run the following command:
yarn run build
Remote Caching
Turborepo can use a technique known as Remote Caching (Beta) 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 (Beta) 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: