Skip to content

AFoaad/create-monorepo-boilerplate

 
 

Repository files navigation

First installation ?

Note: Please checkout the engines property in package.json and make sure you have globally the required engines/versions installed.

- yarn bootstrap (after finished) .
- `cd devpackages/package-builder` and in your terminal run `npm link` .

yarn bootstrap

It will install the required dependencies for the project.

Linking the (package-builder)

It will symlink the package `bin` to the global `bins` on your machine so you can use
the `cli` globally across the project you can also see how to use it by running `package-builder --h` in your terminal.

Project overview

What is packages folder

The `packages` folder is the one that have the `sharable/reusable` packages across the project.

What are modules folders

A `module` is a folder that contains pages/components are only rendered in current module.

What are apps folders

An `app` can contain packages and modules to render pages on the browser.

What is the devpackages folder

The `devpackages` contains packages like `clis` eg. `package-builder`.

package-builder cli

It builds/watches changed files in specified packages and compile it with babel.

What is the internals folder

The `internals` folder contains utilities like helpers to control the process (webpack / generators / nodejs process) .

workspaces folder

contains helper functions to deal with yarn workspaces  packages .

scripts folder

contains helper functions to deal with node js processes.

command-line-utils folder

contains helper functions to deal/create a `cli` .

babel folder

contains configured babel presets/plugins to compile packages / apps (with webpack) .

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.0%
  • TypeScript 11.7%
  • Handlebars 4.8%
  • Other 0.5%