Skip to content

develop.md

Latest commit

 

History

History
38 lines (27 loc) · 1.03 KB

develop.md

File metadata and controls

38 lines (27 loc) · 1.03 KB

Development

The cli is node app built on the oclif command line framework.

To install dependencies, run yarn in the root:

yarn

In development a .env file is used:

MAILSCRIPT_CONFIG_PATH=.mailscript-test # override path to use for .mailscript config file
MAILSCRIPT_LOGIN_URL=http://localhost:3000 # login website url
MAILSCRIPT_API_SERVER=http://localhost:7000/v2 # api server url
MAILSCRIPT_EMAIL_DOMAIN=mailscript.io # the domain to use when assign email addresses (mailscript.io in development)
MAILSCRIPT_DAEMON_BRIDGE_URL=ws://localhost:8888 # the daemon bridge service endpoint

If a .env file is not used, the cli will use the default live values.

To run a command:

node bin/run version

Publishing

To publish to npm, ensure you are on the main branch and that all tests pass. Then run increment the version and publish:

yarn test
npm version patch # or minor or major
git push # so the updated version number is in git
npm publish # you need to be logged in as team@mailscript.com