Reverse Architecture Turborepo

This is an official npm starter turborepo.

What's inside?

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

Apps and Packages

• apps/restruct-app: an application for creating and managing arhitecture workspaces and projects using C4 model and Structurizr language syntax.
• apps/restruct-vscode-extensions: a Visual Studio Code extension for previewing the diagrams of a code written in Structurizr language.
• apps/restruct-vscode-webview: a React app that is hosted inside the webview of the Visual Studio Code extension.
• packages/*: a set of common packages shared between Visual Studio Code extension project and React webview app.
• packages/@justmegaara/mxgraph: a TypeScript library that defines types for MXGrap vector diagrams (draw.io diagrams).
• packages/@justmegaara/graphviz-dot: a very simple and limited builder of the Graphviz graphs in dot syntax (used internally).
• packages/@monaco-editor/structurizr: a Structurizr DSL language definition types for Monaco editor.
• packages/@restruct/*: a set of packages with common commponents and styles for the product suite.
• packages/@structurizr/*: a set of packages to work with Structurizr DSL and C4 model (native SVG implementation).
• packages/@workspace/*: a set of packages to work with Structurizr DSL and C4 model (react flow implementation).
• packages/@yjs/react: a package to work with Yjs framework in React.
• @yjs/react: a set of components and providers to work with Yjs framework in React.
• eslint-config-custom: eslint configurations (includes eslint-config-next and 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

Build

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

cd ./reverse-architecture-web
turbo run build

Develop

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

cd ./reverse-architecture-web
turbo run 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:

cd ./reverse-architecture-web
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:

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