Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 871 Bytes

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 871 Bytes

Developing

Clone the project and run npm install, then start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of the library, everything inside src/routes is for the docs site.

Before committing changes, format the code with Prettier:

npm run format

Testing

To run the test suite:

npm test

Also check that there are no type errors:

npm run check

Building

To build the library:

npm run package

To create a production version of the docs site:

npm run build

You can preview the production build with npm run preview.

Deploying docs site

npm run deploy

Publishing

To publish the library to npm:

npm publish