Before doing any development in the front-end, ensure that Node.js is installed. To install Node.js, you can do one of the following:
- Download and install the LTS version, or
- Download and install nvm (win) and follow their instructions to install the Node.js LTS version (recommended), or
- Download and install n and follow their instructions to install the Node.js LTS version, or
- Install Node.js via Homebrew (macOS only)
brew install node
For bundling, we use Webpack via the webpacker since the backend is Ruby on Rails.
There is some legacy code which is old school JS, but for all things new, Preact is where it's at. If you're new to Preact, check out their documentation. Also, consider following the #preact tag on dev.to.
We use Storybook to develop components. It allows you to focus on building components without the burden of the whole application running. If you're new to Storybook, check out their documentation. Also, consider following the #storybook tag on dev.to.
To get Storybook running on your local:
- 📦 Run
npm installoryarnto ensure all your dependencies are installed. - 🏁 Run
npm run storybookoryarn storybookto start Storybook. - 🏗️ Start working on your component and see the changes in Storybook as you save.
We do not officially support any version of IE or any browser not listed here, but don't go out of your way to not support it! And if there is anything we should change about this, open an issue.