Skip to content

Commit e9de82e

Browse files
committed
first commit
0 parents  commit e9de82e

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

README.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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 Design Systems for Developers tutorial template
9+
</h1>
10+
11+
This template ships with the main React 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/learnstorybook-design-system-template learnstorybook-design-system
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 learnstorybook-design-system/
31+
32+
# Install the dependencies
33+
yarn
34+
```
35+
36+
1. **Open the source code and start editing!**
37+
38+
Open the `learnstorybook-design-system` directory in your code editor of choice and building your first component!
39+
40+
## 🔎 What's inside?
41+
42+
A quick look at the top-level files and directories included with this template.
43+
44+
.
45+
├── node_modules
46+
├── src
47+
├── .babelrc.json
48+
├── .gitignore
49+
├── .prettierignore
50+
├── .prettierrc
51+
├── LICENSE
52+
├── package.json
53+
├── rollup.config.mjs
54+
├── vite.config.js
55+
├── yarn.lock
56+
└── README.md
57+
58+
1. **`node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages).
59+
60+
2. **`src`**: This directory will contain all of the code related to what you will see on your application.
61+
62+
3. **`.babelrc.json`**: This file tells babel which presets and plugins to use when transforming your code.
63+
64+
4. **`.gitignore`**: This file tells git which files it should not track or maintain during the development process of your project.
65+
66+
5. **`.prettierignore`**: This file tells prettier which files it should not format.
67+
68+
6. **`.prettierrc`**: This file tells prettier which rules to use when formatting your code.
69+
70+
7. **`LICENSE`**: The template is licensed under the MIT licence.
71+
72+
8. **`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.
73+
74+
9. **`rollup.config.mjs`**: This file tells rollup which plugins to use when bundling your code.
75+
76+
10. **`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).**
77+
78+
11. **`vite.config.js`**: This file tells [Vite](https://vitejs.dev/) which plugins to use when bundling your code.
79+
80+
12. **`README.md`**: A text file containing useful reference information about the project.
81+
82+
## Contribute
83+
84+
If you encounter an issue with the template, we encourage you to open an issue in this template's repository.
85+
86+
## Learning Storybook
87+
88+
1. Read our introductory tutorial over at [Storybook tutorials](https://storybook.js.org/tutorials/intro-to-storybook/react/en/get-started/).
89+
2. Learn how to transform your component libraries into design systems in our [Design Systems for Developers](https://storybook.js.org/tutorials/design-systems-for-developers/) tutorial.
90+
3. See our official documentation at [Storybook](https://storybook.js.org/).

0 commit comments

Comments
 (0)