https://github.com/renli-tech/monorepo
A template for monorepo projects
https://github.com/renli-tech/monorepo
Last synced: 12 months ago
JSON representation
A template for monorepo projects
- Host: GitHub
- URL: https://github.com/renli-tech/monorepo
- Owner: renli-tech
- License: mit
- Created: 2021-08-15T10:55:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-26T17:28:22.000Z (12 months ago)
- Last Synced: 2025-06-26T18:34:17.102Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# monorepo
A template for monorepo projects
> The word monorepo is a combination between “mono”, as in the Greek word mónos (in translation, alone) and an abbreviation of the word repository. A simple concept if taken verbatim: one lonely repository. The domain is software engineering so we’re referring to a home for source code, multimedia assets, binary files, and so on. But this definition is just the tip of the iceberg, since a monorepo in practice is so much more.
### 😎 Guide
The monorepo structure is managed with [Lerna](https://lerna.js.org/)
### 🧩 Branches
- [Master](./) - with default configuration
- [With Rollup](https://github.com/renli-tech/monorepo/tree/with-rollup) - with [Rollup](https://rollupjs.org/guide/en/) configuration for bundling files
#### 😋 Features
- [Eslint](https://eslint.org/) - For linting code
- [Typescript](https://www.typescriptlang.org/) - As programming language
- [Husky](https://typicode.github.io/husky/#/) - For running pre-commit hooks
- [Jest](https://jestjs.io/) - For testing
- [Prettier](https://prettier.io/) - For writing neat code
- [Commitlint](https://commitlint.js.org/#/) - For linting commit messages
#### Commands
To start working with a project built with this template
Run this command to bootstrap all the packages and install the dependencies
```sh
yarn bootstrap
```
#### Testing
Run this command to run all test
```sh
yarn run test
```
View the [lerna docs](https://lerna.js.org/) to see other commands
This template is maintained by [Renli](https://github/renli-tech)
Licence [MIT](./LICENSE)