/low-code-monorepo

Primary LanguageGo

Project Name Here

Getting Started

  1. Clone this repository
  2. Make sure Node.js version 18.16 or higher is installed (you can use nvm to manage Node.js versions)
  3. Run npm i to install dependencies
  4. Run npm run dev to start the development server
  5. Open http://localhost:3000 with your browser to see the result

Development

Commit Messages

Follow the Conventional Commits specification.

Branching

  • main: The main branch. This branch is protected and cannot be pushed to directly.
  • dev: The development branch, where all new features are merged into.
  • feature/<feature-name>: A feature branch. This branch is branched off of dev and merged back into dev when the feature is complete.
  • fix/<fix-name>: A fix branch. This branch is branched off of dev and merged back into dev when the fix is complete.

Common commands

Install dependencies

For all packages
npm i
For a workspace
npm i <package-name> --workspace=<package-name>

Run the following command:

npx create-turbo@latest

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • docs: a Next.js app
  • web: another Next.js app
  • @repo/ui: a stub React component library shared by both web and docs applications
  • @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @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:

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: