mertani-web-toolkit 0.1.18 → 0.1.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -60
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
# Svelte library
|
|
2
|
-
|
|
3
|
-
Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
|
|
4
|
-
|
|
5
|
-
Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
|
|
6
|
-
|
|
7
|
-
📘 **Documentation:** [storybook.mertani.com](https://storybook.mertani.com/)
|
|
8
|
-
|
|
9
|
-
## Creating a project
|
|
10
|
-
|
|
11
|
-
If you're seeing this, you've probably already done this step. Congrats!
|
|
12
|
-
|
|
13
|
-
```sh
|
|
14
|
-
# create a new project in the current directory
|
|
15
|
-
npx sv create
|
|
16
|
-
|
|
17
|
-
# create a new project in my-app
|
|
18
|
-
npx sv create my-app
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Developing
|
|
22
|
-
|
|
23
|
-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
|
24
|
-
|
|
25
|
-
```sh
|
|
26
|
-
npm run dev
|
|
27
|
-
|
|
28
|
-
# or start the server and open the app in a new browser tab
|
|
29
|
-
npm run dev -- --open
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
|
|
33
|
-
|
|
34
|
-
## Building
|
|
35
|
-
|
|
36
|
-
To build your library:
|
|
37
|
-
|
|
38
|
-
```sh
|
|
39
|
-
npm pack
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
To create a production version of your showcase app:
|
|
43
|
-
|
|
44
|
-
```sh
|
|
45
|
-
npm run build
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
You can preview the production build with `npm run preview`.
|
|
49
|
-
|
|
50
|
-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
|
51
|
-
|
|
52
|
-
## Publishing
|
|
53
|
-
|
|
54
|
-
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/)).
|
|
55
|
-
|
|
56
|
-
To publish your library to [npm](https://www.npmjs.com):
|
|
57
|
-
|
|
58
|
-
```sh
|
|
59
|
-
npm publish
|
|
60
|
-
```
|
|
1
|
+
# Svelte library
|
|
2
|
+
|
|
3
|
+
Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
|
|
4
|
+
|
|
5
|
+
Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
|
|
6
|
+
|
|
7
|
+
📘 **Documentation:** [storybook.mertani.com](https://storybook.mertani.com/)
|
|
8
|
+
|
|
9
|
+
## Creating a project
|
|
10
|
+
|
|
11
|
+
If you're seeing this, you've probably already done this step. Congrats!
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
# create a new project in the current directory
|
|
15
|
+
npx sv create
|
|
16
|
+
|
|
17
|
+
# create a new project in my-app
|
|
18
|
+
npx sv create my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Developing
|
|
22
|
+
|
|
23
|
+
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
npm run dev
|
|
27
|
+
|
|
28
|
+
# or start the server and open the app in a new browser tab
|
|
29
|
+
npm run dev -- --open
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
|
|
33
|
+
|
|
34
|
+
## Building
|
|
35
|
+
|
|
36
|
+
To build your library:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npm pack
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
To create a production version of your showcase app:
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
npm run build
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
You can preview the production build with `npm run preview`.
|
|
49
|
+
|
|
50
|
+
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
|
51
|
+
|
|
52
|
+
## Publishing
|
|
53
|
+
|
|
54
|
+
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/)).
|
|
55
|
+
|
|
56
|
+
To publish your library to [npm](https://www.npmjs.com):
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
npm publish
|
|
60
|
+
```
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED