https://github.com/barelyhuman/mono
My monorepo templates , with an additional ESM supported setup
https://github.com/barelyhuman/mono
cjs esm monorepo nodejs workspaces yarn
Last synced: 3 months ago
JSON representation
My monorepo templates , with an additional ESM supported setup
- Host: GitHub
- URL: https://github.com/barelyhuman/mono
- Owner: barelyhuman
- Created: 2021-05-24T17:29:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T14:26:29.000Z (11 months ago)
- Last Synced: 2025-02-26T15:40:03.228Z (4 months ago)
- Topics: cjs, esm, monorepo, nodejs, workspaces, yarn
- Language: JavaScript
- Homepage:
- Size: 467 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# mono
Simple mono repo setups as a base for a generic
- Shared
- Components
- Web
- Core (Backend)
folder structure
## Flavors
- dev - generic build everything to older node(cjs) compatible code
- esm - use modules (esm) and no backward compiling to have a pure esm setup
- dev-modified - same as dev but uses `react-rewired` to avoid having to rebuild
components package again and again
## Getting Started
The repository uses Yarn workspaces to handle the packages right now and you can
do the following to setup the base development environment.
- Start by cloning the repo and switching to the needed flavor or download the
`tar.gz` of the respective flavor.
- Then delete the `.git` folder if you cloned , don't have to delete if you
downloaded the tarball.
```sh
$ rm -rf .git
```
- Now make sure you have `yarn` installed and then just run
```sh
$ yarn
```
## Documentations
## main flavor
This is mostly a version that has been polished through trial and error of
multiple other projects built by me.
I don't use monorepos a lot but this is based of the times where it was
absolutely needed
### dev flavor
This is a generic flavor that most people could use if you are moving code from
older node version , basically < v11 , as those versions of node don't support
ESM (EcmaScript Modules), the setup comes with individual build commands for
each package and an overall build if needed, the individual builds are needed
for the `shared` and `components` packages to work with the web and core setup,
since you need to convert them into cjs before it can be used.
### esm flavor
This is the preferred way of going ahead if you are building a new project and
have no dependencies on older node versions and can start with the latest LTS
which supports modules. This is a pure module based approach and you don't need
any additional build setup for the `shared` and `components` steps as they are
all modules and will be imported as such in the `core` and `web` projects with
the exception of components since they need to be converted to JS from JSX
### dev-modified
This is an optional version that I included since people might not want to move
to a ESM setup but still want the `components` and `web` to work in sync with
each other without having to rebuild the components every time you make a
change, or you could just leave it in watch mode `yarn shared:build --watch` but
this adds `react-app-rewired` to modify webpack to make sure it compiles the
components during both dev and building automatically.