https://github.com/jamespatrickgibson/union

A design system boilerplate for Svelte & CSS
https://github.com/jamespatrickgibson/union

css-custom-properties design-system svelte-components sveltejs

Last synced: 3 days ago
JSON representation

A design system boilerplate for Svelte & CSS

• Host: GitHub
• URL: https://github.com/jamespatrickgibson/union
• Owner: jamespatrickgibson
• Created: 2019-10-22T13:42:15.000Z (almost 5 years ago)
• Default Branch: next
• Last Pushed: 2021-10-15T15:01:18.000Z (almost 3 years ago)
• Last Synced: 2024-04-24T18:55:28.250Z (5 months ago)
• Topics: css-custom-properties, design-system, svelte-components, sveltejs
• Language: Svelte
• Homepage: http://www.designwithunion.com
• Size: 1.07 MB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Union

Union is a design system boilerplate and component library which is inspired by traditional graphic design theories and practices.

_Union should be considered pre-release and currently unstable for production use._

## create-svelte

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);

## Creating a project

If you're seeing this, you've probably already done this step. Congrats!

```bash

# create a new project in the current directory

npm init svelte@next

# create a new project in my-app

npm init svelte@next my-app

```

> Note: the `@next` is temporary

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash

npm run dev

# or start the server and open the app in a new browser tab

npm run dev -- --open

```

## Building

Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:

```bash

npm run build

```

> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.