Skip to content

Minimal monorepo boilerplate featuring NPM Workspaces along with TypeScript, Webpack and ESLint

License

Notifications You must be signed in to change notification settings

icmx/just-monorepo

Repository files navigation

🛠️ Just Monorepo

Minimal monorepo boilerplate featuring NPM Workspaces along with TypeScript, Webpack and ESLint.

  • See SPECS for project sample business processes
  • See HOWTO for guide to set up monorepo like this

Features

Usage

Clone this repository:

git clone https://github.com/icmx/just-monorepo

Go to local saved copy:

cd just-monorepo

Install dependencies:

npm install

Note: this project requires NPM v7 or higher. If you haven't one, there are some options.

Build packages:

npm run build

One can also build a specific package, e.g. npm run build:client.

Run live-reload for applications packages:

npm run watch:client
npm run watch:server

Note: client application requires server application running. They can be started together on separate terminals e.g.

Lint packages:

npm run lint

One can also lint specific package, e.g. npm run lint:client.

How it looks like?

This project isn't about UI, but in case you need to see it, here it is:

Screenshot of project user interface

Motivation

There are lots of similar boilerplates already indeed. However, most of them are incredibly bloated by endless dependencies, which may be deprecated, outdated and not even used at all, thus I suppose there should be some really lightweight and easy to use alternative.

Please note that packages choice for Just Monorepo not only bare, but also sane — this project is not about making it as small as possible.

Structure

Project structure is described in HOWTO.

See Also

  • Just Gulp — same project, but much smaller and for bundling frontend application by using gulp.
  • Just Webpack — same, but for Webpack.