Illustrates a sample monorepo configuration for use with the Rush tool
Clone or download

README.md

Example Rush Monorepo

This template is part of the documentation of the Rush tool. It contains documentated templates for all the standard Rush configuration files. It also includes three barebones projects that illustrate some dependency relationships in a Rush repo:

  • apps/my-app: The web application
  • libraries/my-controls: A control library used by the application
  • tools/my-toolchain: A NodeJS build tool used to compile the other projects

(These projects are NOT meant to provide a realistic tool chain.)

Building this repo

To build the projects in this repo, try these shell commands:

npm install -g @microsoft/rush
rush install
rush build

For more information, see the documentation at: https://rushjs.io/

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.