https://github.com/gocs/onboarding

onboarding
https://github.com/gocs/onboarding

Last synced: about 1 month ago
JSON representation

onboarding

• Host: GitHub
• URL: https://github.com/gocs/onboarding
• Owner: gocs
• Created: 2023-07-06T14:22:36.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-30T00:36:25.000Z (11 months ago)
• Last Synced: 2024-01-30T02:06:57.199Z (11 months ago)
• Language: JavaScript
• Size: 231 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# onboarding

onboarding

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

Read more about creating a library [in the docs](https://kit.svelte.dev/docs/packaging).

## 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 create svelte@latest

# create a new project in my-app

npm create svelte@latest my-app

```

## 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

```

Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.

## Building

To build your library:

```bash

npm run package

```

To create a production version of your showcase app:

```bash

npm run build

```

You can preview the production build with `npm run preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

## Publishing

Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).

To publish your library to [npm](https://www.npmjs.com):

```bash

npm publish

```