Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/seantrane/monorepo

:herb: A monorepo starter kit
https://github.com/seantrane/monorepo

lerna monorepo semantic-release

Last synced: 5 days ago
JSON representation

:herb: A monorepo starter kit

Host: GitHub
URL: https://github.com/seantrane/monorepo
Owner: seantrane
License: isc
Created: 2018-11-07T23:16:40.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2021-08-02T13:26:26.000Z (over 3 years ago)
Last Synced: 2023-08-13T04:10:47.639Z (over 1 year ago)
Topics: lerna, monorepo, semantic-release
Language: JavaScript
Homepage:
Size: 466 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 19
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        # @seantrane/monorepo

> A monorepo starter kit.

---

[![Build Status](https://travis-ci.com/seantrane/monorepo.svg?branch=master)](https://travis-ci.com/seantrane/monorepo) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Code Coverage](https://sonarcloud.io/api/project_badges/measure?project=seantrane%3Amonorepo&metric=coverage)](https://sonarcloud.io/component_measures?id=seantrane%3Amonorepo&metric=coverage) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=seantrane%3Amonorepo&metric=security_rating)](https://sonarcloud.io/component_measures?id=seantrane%3Amonorepo&metric=security_rating) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=seantrane%3Amonorepo&metric=reliability_rating)](https://sonarcloud.io/component_measures?id=seantrane%3Amonorepo&metric=reliability_rating) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=seantrane%3Amonorepo&metric=sqale_rating)](https://sonarcloud.io/component_measures?id=seantrane%3Amonorepo&metric=sqale_rating)

## Table of Contents

- [About the Repository](#about)

- [Install](#install)

- [Usage](#usage)

- [Support](#support)

- [Contributing](#contributing)

- [Changelog](#changelog)

- [License](#license)

---

## About the Repository 

This is a monorepo for the management of many packages. There are a few dependencies that make this possible;

- [lerna](https://lernajs.io/): a tool for managing *JavaScript* projects with multiple packages.

- [semantic-release-monorepo](https://github.com/Updater/semantic-release-monorepo): use [semantic-release](https://github.com/semantic-release/semantic-release) within a monorepo.

Read [CONTRIBUTING.md](https://github.com/seantrane/monorepo/blob/master/CONTRIBUTING.md) documentation for more details.

## Install 

```sh

# Install lerna globally (to use lerna binary at command line)

npm install -g lerna

# Install repo dependencies, link local packages together and install remaining package dependencies

npm install

```

## Usage 

### CLI

```sh

# List local packages

npm run list

# Run tests across all packages

npm test

# Run linting, tests and builds across all packages

npm run ci

# Clean all auto-generated files

npm run clean

# Uninstall all packages

npm run uninstall

```

Read [CONTRIBUTING.md](https://github.com/seantrane/monorepo/blob/master/CONTRIBUTING.md) documentation for more details.

---

## Support 

Submit an [issue](https://github.com/seantrane/monorepo/issues/new), in which you should provide as much detail as necessary for your issue.

## Contributing 

Contributions are always appreciated. Read [CONTRIBUTING.md](https://github.com/seantrane/monorepo/blob/master/CONTRIBUTING.md) documentation to learn more.

## Changelog 

Release details are documented in the CHANGELOG.md file of each package, and on the [GitHub Releases page](https://github.com/seantrane/monorepo/releases).

---

## License 

[ISC License](https://github.com/seantrane/monorepo/blob/master/LICENSE)

Copyright (c) 2018, [Sean Trane Sciarrone](https://github.com/seantrane)