Running the Project

Cloning the repo Jump to heading #

To set up a local development environment, fork the repo on GitHub, clone it locally, and install its dependencies.

git clone https://github.com/YOUR_GITHUB_USERNAME/quiet
cd quiet
npm install

Starting the dev server Jump to heading #

Once you've cloned the repo, run the following command to launch the development server.

npm start

This will open a browser showing the docs. As you work, the browser will automatically reload.

Building for production Jump to heading #

When you're ready to create a production build, use the following command.

npm run build

The dist folder will contain the files you want.

There are a number of commands you can use to lint and test the library. For a full list of them, use npm run.

Running tests Jump to heading #

Quiet uses Web Test Runner to test in actual browsers. Once installed and built, the following command will launch the test runner.

npm run test

If you want to test a single component, pass the tag name without the quiet- prefix like this.

npm run test:component button