0.0.1 โ€ข Published 1 year ago

monorepo-essentials v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Monorepo Essentials - A superset of tools and configurations for monorepos

GitHub license npm version

This repository is a template for JavaScript monorepos. It contains a set of tools and configurations that are essential for the management of a monorepo. It is designed to be used as a starting point for the creation of a new monorepo.

Table of contents

โœจ Features

๐Ÿ Getting started

๐Ÿ—‚ Repository structure

Here is a summary of the monorepo's architecture with the main files and folders:

  • โš™๏ธ .config/ : configuration files for the monorepo tools and dev-libraries.
  • ๐Ÿช .hooks/ : scripts that are executed by git hooks.
  • ๐Ÿงถ .yarn/ : yarn executables and their configurations (plugins, constraints, deps patches, etc.)
  • ๐Ÿ“ฆ packages/ : projects, libraries, applications, etc. that are part of the monorepo.
  • ๐ŸŽจ resources/ : assets of the monorepo.
  • ๐Ÿ .editorconfig : configuration file for the IDE.
  • โš™๏ธ .gitconfig : git configuration file.
  • ๐Ÿ—‘๏ธ .gitignore : list of files and folders to exclude from git.
  • ๐Ÿงถ .yarnrc.yml : yarn configuration file.
  • โš–๏ธ LICENSE : license file.
  • ๐Ÿงถ yarn.config.cjs : javascript configuration file for yarn (required to define constraints location).
  • ๐Ÿ”’ yarn.lock : lockfile which pin dependencies versions.
  • ๐Ÿ“„ Other files : configuration and documentation files.

๐Ÿงฐ Stack technique

โž• Pour plus d'informations