Skip to content

Dev Environment

Preet edited this page Apr 23, 2019 · 3 revisions

Here's how to set up your dev environment if you're tinkering with wired-elements.

wired-elements is a monorepo for the individual element packages. lerna is used to manage these packages, and they need to be bootstrapped.

After you have cloned the repository, navigate to the wired-elements folder and bootstrap the packages:

npm run bootstrap

This will install all the npm dependencies and hoist all the individual packages. (Even though wired-elements doesn't depend on much, you'll notice a lot get added to node_modules for setting up the lerna dev environment)

Compiling

All the code is written in typescript so it needs to be compiled to JavaScript before it could be served up.

npm run tsc

This will compile individual packages and the output js files will be places in each package's lib folder.

Trying it out (Serving the packages)

Start the dev server:

npm run dev

This will start a local server to serve all the packages with resolved relative paths. It will output the address where the server is hosted.

Open the browser and navigate to the host-url/examples/basic.html. For example:

http://127.0.0.1:8000/examples/basic.html

You can create your own test html pages to test out all components. Use basic.html as a template to try them out.

Clone this wiki locally