https://github.com/kenoxa/svelkit

Svelte Toolkit
https://github.com/kenoxa/svelkit

components js svelte web

Last synced: 3 months ago
JSON representation

Svelte Toolkit

• Host: GitHub
• URL: https://github.com/kenoxa/svelkit
• Owner: kenoxa
• License: mit
• Created: 2020-07-06T16:16:51.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T07:08:17.000Z (about 2 years ago)
• Last Synced: 2024-10-30T08:04:30.625Z (3 months ago)
• Topics: components, js, svelte, web
• Language: TypeScript
• Homepage:
• Size: 4.29 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Svelkit

> Collection of packages to create [svelte] apps.

[![License](https://badgen.net/github/license/kenoxa/svelkit)](https://github.com/kenoxa/svelkit/blob/main/LICENSE)

[![CI](https://github.com/kenoxa/svelkit/workflows/CI/badge.svg)](https://github.com/kenoxa/svelkit/actions?query=workflow%3Aci)

[![Coverage Status](https://badgen.net/coveralls/c/github/kenoxa/svelkit/main)](https://coveralls.io/github/kenoxa/svelkit?branch=main)

[![PRs Welcome](https://badgen.net/badge/PRs/welcome/purple)](http://makeapullrequest.com)

[![Conventional Commits](https://badgen.net/badge/Conventional%20Commits/1.0.0/cyan)](https://conventionalcommits.org)

- [Usage](#usage)

- [Packages](#packages)

- [Support](#support)

- [Contribute](#contribute)

- [License](#license)

## Usage

[svelkit] components work in isolation. They are self-supporting, and will only inject the styles they need to display. They don't rely on any global style-sheets such as [normalize.css](normalize.css).

You can use any of the components as demonstrated in the documentation. Please refer to each component's [demo page](https://svelkit.js.org) to see how they should be imported.

### Baseline

[svelkit] provides an optional [baseline](./packages/baseline/README.md) component. It fixes some inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.

## Packages

### Components

- [@svelkit/baseline](./packages/baseline): A baseline component to kickstart an elegant, consistent, and simple baseline to build upon.

- [@svelkit/chip](./packages/chip): A chip component

- [@svelkit/delay](./packages/delay): A delay component

- [@svelkit/scoped-baseline](./packages/scoped-baseline): A scoped baseline component to progressively kickstart an elegant, consistent, and simple baseline to build upon.

### Service

- [@svelkit/graphql](./packages/graphql): A lightweight [GraphQL] client

### Hooks

## Support

This project is free and open-source, so if you think this project can help you or anyone else, you may [star it on GitHub](https://github.com/kenoxa/svelkit). Feel free to [open an issue](https://github.com/kenoxa/svelkit/issues) if you have any idea, question, or you've found a bug.

## Contribute

Thanks for being willing to contribute!

**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

We are following the [Conventional Commits](https://www.conventionalcommits.org) convention.

### Develop

- `yarn test`: Run test suite including linting

- `yarn format`: Ensure consistent code style

- `yarn storybook`: Start the component showroom

- `yarn publish`: To publish all changed packages

## License

`svelkit` is open source software [licensed as MIT](https://github.com/kenoxa/svelkit/blob/main/LICENSE).

[svelkit]: https://svelkit.js.org/

[svelte]: https://svelte.dev/

[graphql]: https://graphql.org/