Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.98 KB
Raw

Contribution guide

:octicons-heart-fill-24:{ .color-red } Thank you for your interest in making ILC better. Your contributions are highly welcome.

Install and setup LDE

  1. Clone the namecheap/ilc repository.
  2. Run npm install
  3. Run npm start
  4. Open your browser and navigate to ILC or Registry UI:

!!! tip "Dev mode for demo applications" With the commands above, you start ILC with a set of demo applications running inside the Docker container. It is OK when you work with ILC. However, when you need to develop those applications alongside ILC, you should switch them into dev mode.

To switch demo applications into dev mode:

1. Clone the [ilc-demo-apps](https://github.com/namecheap/ilc-demo-apps)
1. Open a new Terminal instance (alongside the running one with ILC).
1. Run `npm run start:no-apps`

Run E2E tests

We use E2E tests to ensure that all ILC components work together properly.

We use our Demo applications as a test platform for micro-frontends and also to ensure that backward compatibility is not broken.

To run E2E tests:

  1. Build ILC and Registry: npm run build
  2. Change your current directory to ./e2e
  3. 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

Debug mode

ILC uses the debug package on the client-side to produce verbose logs for debug purposes.

To enable it, type localStorage.debug = 'ILC:*' in your browser console.

Watch and build documentation

  1. Build a Docker image: docker build -t ilc-mkdocs - < ./.mkdocs/Dockerfile
  2. Watch or build documentation:
    • Watch: docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ilc-mkdocs
    • Build: docker run --rm -v ${PWD}:/docs ilc-mkdocs build