Skip to content

Active-Matrix/Proximity

Repository files navigation

Proximity Logo

Proximity

MIT Licence        App Production status

This is a MonoRepo

  • Frontend /packages/web/*
  • Backend /package/backend/*
  • AI Models /packages/ml/*
  • global configs /packages/config

Commit message guidelines

Read the guide

Workspace setup

Prerequisites

  • nvm@latest
  • nodejs 18.x, 20.x
  • pnpm@latest
  • vscode@latest
  • python

Install these VS Code extension:

Monorepo Workspace Prettier

Using CLI

Start web app pnpm dev:web

Build web app pnpm build:web

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: