|
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 React template |
9 | | -</h1> |
10 | | - |
11 | | -This template ships with the main React 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-react-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 | | - ├── .eslintrc.cjs |
55 | | - ├── .gitignore |
56 | | - ├── .yarnrc.yml |
57 | | - ├── index.html |
58 | | - ├── LICENSE |
59 | | - ├── package.json |
60 | | - ├── tsconfig.app.json |
61 | | - ├── tsconfig.json |
62 | | - ├── tsconfig.node.json |
63 | | - ├── yarn.lock |
64 | | - ├── vite.config.js |
65 | | - └── README.md |
66 | | - |
67 | | -1. **`.storybook`**: This directory contains Storybook's [configuration](https://storybook.js.org/docs/configure) files. |
68 | | -
|
69 | | -2. **`.yarn`**: This directory contains the configuration files for Yarn including the cache and the global packages. |
70 | | -
|
71 | | -3. **`node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages). |
72 | | -
|
73 | | -4. **`public`**: This directory will contain the development and production build of the site. |
74 | | -
|
75 | | -5. **`src`**: This directory will contain all of the code related to what you will see on your application. |
76 | | -
|
77 | | -6. **`eslintrc.cjs`**: This file is the configuration file for [ESLint](https://eslint.org/). |
78 | | -
|
79 | | -7. **`.gitignore`**: This file tells git which files it should not track or maintain during the development process of your project. |
80 | | -
|
81 | | -8. **`.yarnrc.yml`**: This file contains the configuration for Yarn. It's used to define the project's settings, such as caching and other settings. |
82 | | -
|
83 | | -9. **`index.html`**: This is the HTML page that is served when generating a development or production build. |
84 | | -
|
85 | | -10. **`LICENSE`**: The template is licensed under the MIT licence. |
86 | | -
|
87 | | -11. **`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. |
88 | | -
|
89 | | -12. **`tsconfig.app.json`**: This file contains the TypeScript compiler options for the project. |
90 | | -
|
91 | | -13. **`tsconfig.json`**: This file is the root TypeScript configuration file that specifies the root files and the compiler options required to compile the project. |
92 | | -
|
93 | | -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. |
94 | | -
|
95 | | -15. **`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. |
96 | | -
|
97 | | -16. **`vite.config.js`**: 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. |
98 | | -
|
99 | | -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).** |
100 | | -
|
101 | | -18. **`README.md`**: A text file containing useful reference information about the project. |
102 | | -
|
103 | | -## Contribute |
104 | | -
|
105 | | -If you encounter an issue with the template, we encourage you to open an issue in this template's repository. |
106 | | - |
107 | | -## Learning Storybook |
108 | | - |
109 | | -1. Read our introductory tutorial at [Learn Storybook](https://storybook.js.org/tutorials/intro-to-storybook/react/en/get-started/). |
110 | | -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. |
111 | | -3. See our official documentation at [Storybook](https://storybook.js.org/). |
| 1 | +# nes-components |
| 2 | +[](https://shields.io/) |
| 3 | +[](https://lbesson.mit-license.org/) [](https://greenkeeper.io/) |
| 4 | +[](https://app.netlify.com/projects/nes-components/deploys) |
| 5 | + |
| 6 | +### What is `nes-components`? |
| 7 | +`nes-components` is a react component that is using NES.css. |
| 8 | + |
| 9 | +### What is `NES.css`? |
| 10 | +NES.css is a NES-style(8bit-like) CSS Framework. |
| 11 | +https://github.com/nostalgic-css/NES.css |
| 12 | + |
| 13 | +### How to use this? |
| 14 | + |
| 15 | +#### install |
| 16 | +``` |
| 17 | +$ yarn add nes-components |
| 18 | +$ npm i nes-components |
| 19 | +``` |
| 20 | + |
| 21 | +## :warning:caution |
| 22 | +if nes-components doesn't show the right font, please add the following to your component. |
| 23 | +Currently, working on updating nes-components |
| 24 | +```js |
| 25 | +import WebFont from 'webfontloader'; |
| 26 | +WebFont.load({ |
| 27 | + google: { |
| 28 | + families: ['Press+Start+2P'], |
| 29 | + }, |
| 30 | +}); |
| 31 | +``` |
| 32 | + |
| 33 | +#### Doc |
| 34 | +Please see StoryBook https://nes-components.netlify.com/ |
| 35 | + |
| 36 | +#### samples ToDo |
| 37 | +Sample codes are in Storybook(`Typescript`). |
| 38 | +Please check it out. |
| 39 | +`js` samples will be added soon. |
| 40 | + |
| 41 | + |
| 42 | +### Use Storybook |
| 43 | +``` |
| 44 | +$ cd nes-components |
| 45 | +$ yarn & yarn storybook |
| 46 | +or |
| 47 | +$ npm i & npm run storybook |
| 48 | +``` |
| 49 | +The terminal will open [localhost:9009](localhost:9009). |
| 50 | + |
| 51 | +You will see like below. |
| 52 | + |
| 53 | + |
0 commit comments