UNPKG

ldx-widgets

Version:

widgets

30 lines (20 loc) • 2.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# LDX web utilities 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 company, this code is probably of little use to you. ## Initial setup This document will serve as a basic guide to getting started with the **ldx-web-utilities** project #### 1. Install Node Version Manager (nvm) if you don't already have Node installed Run the nvm install script using the following command in your terminal: `curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash` #### 2. Install Node versions Once the nvm install script is completed, you can now install various versions of Node. Start by installing Node v6.9 by running `nvm install 6.9`. Nvm will allow you to hot-switch between Node versions when required, using the `nvm use` command. 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 STEP!*** 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. ## Documentation The widgets in this repository have generated [API docs](./docs) used for props documentation. ### Re-generating docs If you have made changes to a component's documentation, and wish to re-generate the doc files, run the following command: `npm run docs`.