https://github.com/microsoft/rush-example
Illustrates a sample monorepo configuration for use with the Rush tool
https://github.com/microsoft/rush-example
rushstack
Last synced: 10 months ago
JSON representation
Illustrates a sample monorepo configuration for use with the Rush tool
- Host: GitHub
- URL: https://github.com/microsoft/rush-example
- Owner: microsoft
- License: mit
- Created: 2018-09-11T21:37:37.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T05:25:54.000Z (about 1 year ago)
- Last Synced: 2025-04-04T04:11:55.825Z (11 months ago)
- Topics: rushstack
- Language: JavaScript
- Homepage:
- Size: 210 KB
- Stars: 149
- Watchers: 5
- Forks: 85
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Example Rush Monorepo
This template is part of the documentation of the [Rush](https://rushjs.io/) tool.
It contains documented 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 toolchain.)
# 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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.