Skip to content

3drepo/PlanBase

Repository files navigation

Planbase

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Typescript Test Compiler

From root directory

ts-node --files src/libs/tdr/main.ts

Compiles and minifies for production

yarn build

Customize configuration

See Configuration Reference.

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Run your unit tests

yarn test:unit

Lints and fixes files

yarn lint-fix

Deployment

Add additional notes about how to deploy this on a live system

Contributing

Versioning

Authors

License

Acknowledgments