Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1018 Bytes

DEVELOPMENT.md

File metadata and controls

29 lines (22 loc) · 1018 Bytes
Raw

Development

Prerequisites

Deepkit uses NPM and Lerna to manage this monorepo. Local package linking is managed through the npm-local-development CLI.

Make sure libpq5 and libpq-dev are installed, and python refers Python2.

Getting Started

git clone https://github.com/deepkit/deepkit-framework.git
cd deepkit-framework
npm install
npm run bootstrap
npm run link
npm run install-compiler

Making changes

In order to make sure that all packages are built correctly and that Jest understands cross-package references you should run the included build watcher commands during local development

npm run tsc-watch
npm run tsc-watch:esm

Notes

  • When one of the package.json files is modified (adding, removing or updating dependencies) you will need to re-run the npm bootstrap and npm link commands from above
  • Never install NPM dependencies directly inside of any of the packages in the packages/* directory.