ldx-widgets
Version:
widgets
22 lines (15 loc) • 2.01 kB
Markdown
This repo is for reusable components and utlity methods, which need to be shared across projects. Note: this is not an open source project, and is intended for use in applicaitons internally at a specific company. If you do not work at said comapny, this code is probably of little use to you.
This document will serve as a basic guide to getting started with the ldx-web-utilities project
Run the nvm install script using the following command in your terminal: `curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.25.4/install.sh | bash`
Once the nvm install script is completed, you can now install various versions of Node. Start by doing `nvm install 0.12` and then `nvm install 0.10`. Nvm will allow you to hot-switch between Node versions when required. If you have previously installed Node by other means (such as Homebrew), you may need to uninstall that implementation before installing it with nvm.
#### 3. Install repo dependencies
Install the repo's dependencies using `npm install`. Note: you may need to install additional dependencies globally using the `-g` flag, e.g.: `npm install gulp -g`
#### 4. Start development environment
Use the `npm start` command to get the development environment running. This will compile changes to js in the `/dist` folder, as well as run tests after each change. Note that when the code is used as a dependency, only the js is required, so if coffee-script changes are not compiled, they will not be usable in production. *SO DO NOT SKIP THIS*
Note: changes are not compiled on startup, so if you forget this step, make a change, then start the dev environment, you must make anohter change to a compilation to take place.
#### 5. Tests, tests, tests
Please ensure that any additions or changes are covered in tests. PRs will not be merged with broken tests or new functionality that is untested.