mertani-web-toolkit 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Chroma Software Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
package/README.md ADDED
@@ -0,0 +1,111 @@
1
+ <p align="center">
2
+ <a href="https://www.chromatic.com/">
3
+ <img alt="Chromatic" src="https://avatars2.githubusercontent.com/u/24584319?s=200&v=4" width="60" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">
8
+ Chromatic's Intro to Storybook Svelte template
9
+ </h1>
10
+
11
+ This template ships with the main Svelte and Storybook configuration files you'll need to get up and running fast.
12
+
13
+ ## πŸš… Quick start
14
+
15
+ 1. **Create the application.**
16
+
17
+ Use [degit](https://github.com/Rich-Harris/degit) to get this template.
18
+
19
+ ```shell
20
+ # Clone the template
21
+ npx degit chromaui/intro-storybook-svelte-template taskbox
22
+ ```
23
+
24
+ 1. **Install the dependencies.**
25
+
26
+ Navigate into your new site’s directory and install the necessary dependencies.
27
+
28
+ ```shell
29
+ # Navigate to the directory
30
+ cd taskbox/
31
+
32
+ # Install the dependencies
33
+ yarn
34
+ ```
35
+
36
+ 1. **Open the source code and start editing!**
37
+
38
+ Open the `taskbox` directory in your code editor of choice and building your first component!
39
+
40
+ 1. **Browse your stories!**
41
+
42
+ Run `yarn storybook` to see your component's stories at `http://localhost:6006`
43
+
44
+ ## πŸ”Ž What's inside?
45
+
46
+ A quick look at the top-level files and directories included with this template.
47
+
48
+ .
49
+ β”œβ”€β”€ .storybook
50
+ β”œβ”€β”€ .yarn
51
+ β”œβ”€β”€ node_modules
52
+ β”œβ”€β”€ public
53
+ β”œβ”€β”€ src
54
+ β”œβ”€β”€ .gitignore
55
+ β”œβ”€β”€ .yarnrc.yml
56
+ β”œβ”€β”€ index.html
57
+ β”œβ”€β”€ LICENSE
58
+ β”œβ”€β”€ package.json
59
+ β”œβ”€β”€ svelte.config.js
60
+ β”œβ”€β”€ tsconfig.app.json
61
+ β”œβ”€β”€ tsconfig.json
62
+ β”œβ”€β”€ tsconfig.node.json
63
+ β”œβ”€β”€ vite.config.ts
64
+ β”œβ”€β”€ vitest.shims.d.ts
65
+ β”œβ”€β”€ yarn.lock
66
+ └── README.md
67
+
68
+ 1. **`.storybook`**: This directory contains Storybook's [configuration](https://storybook.js.org/docs/configure) files.
69
+
70
+ 2. **`.yarn`**: This directory contains the configuration files for Yarn including the cache and the global packages.
71
+
72
+ 3. **`node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages).
73
+
74
+ 4. **`public`**: This directory will contain the development and production build of the site.
75
+
76
+ 5. **`src`**: This directory will contain all of the code related to what you will see on your application.
77
+
78
+ 6. **`.gitignore`**: This file tells git which files it should not track or maintain during the development process of your project.
79
+
80
+ 7. **`.yarnrc.yml`**: This file contains the configuration for Yarn. It's used to define the project's settings, such as caching and other settings.
81
+
82
+ 8. **`index.html`**: This is the HTML page that is served when generating a development or production build.
83
+
84
+ 9. **`LICENSE`**: The template is licensed under the MIT licence.
85
+
86
+ 10. **`package.json`**: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.
87
+
88
+ 11. **`svelte.config.js`**: This file contains the configuration for Svelte, a modern JavaScript framework for building user interfaces. It includes settings for preprocessors, compiler options, and other Svelte-specific configurations.
89
+
90
+ 12. **`tsconfig.app.json`**: This file contains the TypeScript compiler options for the project.
91
+
92
+ 13. **`tsconfig.node.json`**: This file contains the TypeScript compiler options required to manage the Node.js environment in the project configuration files. Used to help distinguish between configurations for different parts of the project.
93
+
94
+ 14. **`tsconfig.json`**: This file is the root TypeScript configuration file that specifies the root files and the compiler options that could be extended by other configuration files in the project.
95
+
96
+ 15. **`vite.config.ts`**: This is the configuration file for [Vite](https://vitejs.dev/), a build tool that aims to provide a faster and leaner development experience for modern web projects.
97
+
98
+ 16. **`vitest.shims.d.ts`**: This file contains TypeScript type definitions for Vitest, a testing framework that is used to run tests in the project.
99
+
100
+ 17. **`yarn.lock`**: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(Do not change it manually).**
101
+
102
+ 18. **`README.md`**: A text file containing useful reference information about the project.
103
+
104
+ ## Contribute
105
+
106
+ If you encounter an issue with the template, we encourage you to open an issue in this template's repository.
107
+
108
+ ## Learning Storybook
109
+
110
+ 1. Read our introductory tutorial at [Learn Storybook](https://storybook.js.org/tutorials/intro-to-storybook/svelte/en/get-started/).
111
+ 2. See our official documentation at [Storybook](https://storybook.js.org/).