https://github.com/dkelosky/nodejs-typescript-monorepo

https://github.com/dkelosky/nodejs-typescript-monorepo

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dkelosky/nodejs-typescript-monorepo
• Owner: dkelosky
• License: other
• Created: 2021-11-11T13:40:22.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T16:34:00.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T02:15:08.708Z (3 months ago)
• Language: TypeScript
• Size: 707 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node.js Typescript Monorepo Boilerplate

This is a sample client / server monorepo project that uses:

* [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces)

* [eslint](https://eslint.org/)

* [typescript](https://www.typescriptlang.org/)

* [jest](https://jestjs.io/)

* [GitHub Actions](https://docs.github.com/en/actions)

The [server](packages/server/README.md) is a sample Server Side Events server to stream events to a Node.js [client](packages/client/README.md).

## Setup

* `npm install`

## Target Workspaces

Use one package, e.g.:

`npm run echo --workspace=@sse/server`

Use all packages:

`npm run echo --workspaces`

## Package Dependencies

Packages can depend on each other.  E.g.

`package.json` specify name of package in `dependencies`:

```json

  "dependencies": {

    "@sse/common": "1.0.0"

  },

```

`tsconfig.json` specify relative path of package __folder__ name

```json

  "references": [{ "path": "../common" }]

```

## Build

`npm run build`

## Test

* `npm test`