Skip to main content

Environment configuration

In order to work with WebJET Elements, you mainly need an environment with Node.js and npm installed. Since the library uses Custom Elements, Shadow DOM and ES modules, it pays to use a modern browser for development and testing.

What you need​

  • Node.js 18 or newer - to install the package and build the project locally.
  • npm - part of Node.js, used to manage dependencies.
  • Code Editor - for example, Visual Studio Code or WebStorm.
  • Modern browser - for example Chrome, Edge, Firefox or Safari.

Terminal​

When working with WebJET Elements, you will use the terminal to install the package, run the build or the local development server. You don't need to know advanced shell scripting, but a basic understanding of the command line is very useful.

On Windows you can use Command Prompt, PowerShell or Windows Terminal. On macOS and Linux, the built-in terminal is sufficient.

Node & npm​

The recommended minimum version of Node.js is 18+. You can verify the currently installed versions by using the commands below.

For details on installing Node.js, see nodejs.org.

$ node --version
$ npm --version

If you are using a corporate proxy, internal registry or monorepo, we recommend that you also check the .npmrc setting beforehand.

Recommendations​

  • We recommend using the [Git] versioning system(https://git-scm.com/ ) when developing your application.
  • If you are using Vite, webpack or another bundler, make sure the project supports loading ES modules.
  • If you plan to use library assets (icons, for example), prepare a way to serve static files from the wj-elements package in your project.

Content