ng-mono-repo-starter

KO | EN

gitlite — search

#javascript #react #go #linux #docker #windows #awesome #cli #kubernetes #vue #pytorch #openai #ios #mcp

ng-mono-repo-starter

(★ 74)

Angular Mono Repo Starter

ng-mono-repo-starter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CircleCI](https://circleci.com/gh/alan-agius4/ng-mono-repo-starter.svg?style=svg)](https://circleci.com/gh/alan-agius4/ng-mono-repo-starter)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat-square)](https://renovateapp.com/)

# Angular Mono Repo Starter
An Angular mono repository starter kit featuring `Jest`, `Lerna`, `Compodoc`, `scss-bundle` and `ng-packagr`.

## Features
- Flatten SCSS output into a single file to improve build time for consumers
- Supports scoped packages
- Supports secondary entries similar to Angular's Testing Modules.
- All the other features that `Jest`, `Lerna`, `Compodoc` and `ng-packagr` provide.

## The Stack
 - [Lerna](https://lernajs.io) - A tool for managing JavaScript projects with multiple packages. One of the major advantage of Lerna is semantic releases and package version syncing.
 - [Jest](https://facebook.github.io/jest) - Jest is used by Facebook to test all JavaScript code including React applications. One of Jest's philosophies is to provide an integrated "zero-configuration" experience.
 - [ng-packagr](https://github.com/dherges/ng-packagr) - Transpile and Bundle libraries to Angular Package Format.
 - [Compodoc](https://compodoc.github.io/website/guides/getting-started.html) - Compodoc is a documentation tool for Angular applications & libraries. It generates awesome static documentation.
 - [scss-bundle](https://github.com/SimplrJS/scss-bundle) - Bundles all SCSS imports into a single file

## Get Started
To get started, you need to:

1) Clone the repository
```shell
git clone https://github.com/alan-agius4/ng-mono-repo-starter.git <project_name>
```

2) Install dependencies
```
cd <project_name>
npm install
```

Note: There is a `postinstall` script that after `npm install` has finished will bootstrap the mono repo.

## Setting your project scope
It is recommanded that you use [scoped](https://docs.npmjs.com/misc/scope) npm packages. This is set to `@speedy` by default. To change it you need to modify a couple of files.

These are:
- `tsconfig.json`
- `tsconfig.build.json`
- `lerna.json`
- `jest.config.js`

## NPM Tasks

| Task         | Description                                                                                                                                                                                |
| ------------ | -------------------------------------------------------------------------------------------------                                                                                          |
| aio          | Generates a static documentation of your libraries                                                                                                                                         |
| bootstrap    | Install packages dependencies and bootstrap the mono repo                                                                                                                                  |
| build        | Build all the packages inside the mono repo                                                                                                                                                |
| watch        | Build all the packages inside the mono repo and perform an incremental build when a file changes (NB: in case you have cross dependencies it's recommanded that you first perform a build) |
| build-tools  | Build the tools script that are used for building the mono repo                                                                                                                            |
| clean        | Clean up packages `node_modules` and `dist` folders                                                                                                                                        |
| test         | Run unit and integration tests                                                                                                                                                             |
| test-debug   | Run unit and integration tests in debug mode                                                                                                                                               |
| test-tdd     | Run unit and integration tests in watch mode                                                                                                                                               |
| release      | Runs `lerna publish`                   |

## Testing
For this project, I chose Jest as our test framework. While Karma is probably more common for Angular testing, Karma is slower and doesn't offer some important features that Jest does.

### Using the debugger in VS Code
Debugging is one of the places where VS Code really shines over other editors. This project comes pre-configured `launch.json`. All you need to do is hit `F5` in `VS Code` and get debugging!

ng-mono-repo-starter

ng-mono-repo-starter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ng-mono-repo-starter

ng-mono-repo-starter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README