btc-models

Shared models and validation for the Bicycle Touring Companion

BTC-Models offers a way for other parts of the application (like the server and client applications) to agree on how certain pieces of information (such as passwords, emails, schedules, etc…) should look. When included into other parts of the application, btc-models handles logic and functions for it’s represented objects effectively separating out the data-logic code from the view code in the btc-app.

How to link in developement

1. To test a working version of the btc-models, run npm link in the root folder of this repo.
2. Build changes in src by running npm run build
3. Then in any other repo you wish to test btc-models (like btc-app, btc-server, etc...) run npm link btc-models. That's it! To find more info check out the npm-link documents https://docs.npmjs.com/cli/link

How to test

1. Make sure NODE_ENV is set to test
2. run npm run build
3. run npm run test