Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.51 KB
Raw

Contributing to Isomorphic Layout Composer

Thank you for your interest in making ILC even better and more awesome. Your contributions are highly welcome.

Installation and setup of the LDE

  1. Clone the repo
  2. For Namecheap employees only: clone "ilc.internal" repo and follow the guide to setup NC specific applications.
  3. Run npm install
  4. Run npm start
  5. PROFIT 😎
    • Open running code at http://localhost:8233/
    • Registry UI is available at http://localhost:4001/

These steps will start ILC with a set of demo applications running inside Docker container. While it's ok in most of the cases - sometimes you might need to develop those apps alongside ILC.

To do so you need to clone ilc-demo-apps repo and run them in dev mode. At the same time in parallel terminal you need to run npm run start:no-apps

E2E tests

To make sure that all ILC components play well together we use E2E tests. We use our Demo applications as test micro frontends so it also gives us ability to make sure that we don't break backward compatibility.

In order to run tests:

  • Build ILC & Registry by running npm run build
  • Change your current directory to ./e2e
  • Launch one of the following commands:
    • Default mode: npm start
    • Verbose mode: npm run start:verbose
    • Verbose mode with Browser UI visible: npm run start:verbose:ui