https://github.com/lakshitnagar/storybook
Commit tutorial for storybook in Angular
https://github.com/lakshitnagar/storybook
angular angular-cli javascript storybook storybook-angular typescript
Last synced: 2 months ago
JSON representation
Commit tutorial for storybook in Angular
- Host: GitHub
- URL: https://github.com/lakshitnagar/storybook
- Owner: Lakshitnagar
- License: mit
- Created: 2021-02-08T07:24:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-08T13:07:49.000Z (over 5 years ago)
- Last Synced: 2025-03-23T10:25:20.356Z (about 1 year ago)
- Topics: angular, angular-cli, javascript, storybook, storybook-angular, typescript
- Language: HTML
- Homepage: https://lakshitnagar.github.io/storybook/storybook-static/
- Size: 1.76 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chromatic's Intro to Storybook Angular template
This template ships with the main Angular and Storybook configuration files you'll need to get up and running fast.
## 🚅 Quick start
1. **Create the application.**
Use [degit](https://github.com/Rich-Harris/degit) to get this template.
```shell
# Clone the template
npx degit chromaui/intro-storybook-angular-template taskbox
```
1. **Install the dependencies.**
Navigate into your new site’s directory and install the necessary dependencies.
```shell
# Navigate to the directory
cd taskbox/
# Install the dependencies
npm install
```
1. **Open the source code and start editing!**
Open the `taskbox` directory in your code editor of choice and building your first component!
1. **Browse your stories!**
Run `npm run storybook` to see your component's stories at `http://localhost:6006`.
## 🔎 What's inside?
A quick look at the top-level files and directories included with this template.
.
├── .storybook
├── node_modules
├── src
├── .browserslistrc
├── .editorconfig
├── .gitignore
├── angular.json
├── babel.config.js
├── LICENSE
├── package-lock.json
├── package.json
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.spec.json
├── tslint.json
└── README.md
1. **`.storybook`**: This directory contains Storybook's [configuration](https://storybook.js.org/docs/react/configure/overview) files.
2. **`node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages).
3. **`src`**: This directory will contain all of the code related to what you will see on your application.
4. **`.browserslistrc`**: This file will contain the information regarding which browsers will be supported when the application is built.
5. **`.editorconfig`**: This file contains the configurations for [EditorConfig](https://editorconfig.org/).
6. **`.gitignore`**: This file tells git which files it should not track or maintain during the development process of your project.
7. **`angular.json`**: This file contains all the configurations required for your Angular project.
8. **`.babel.config.js`**: This file tells [babel](https://babeljs.io/) how to transpile the application's code.
9. **`LICENSE`**: The template is licensed under the MIT licence.
10. **`package-lock.json`**: 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).**
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.
12. **`tsconfig.app.json`**: This file contains auxiliary configurations for your Angular project.
13. **`tsconfig.json`**: This file contains configurations the required configurations for TypeScript.
14. **`tsconfig.spec.json`**: This is a TypeScript configuration file aimed for application testing.
## Contribute
If you encounter an issue with the template, we encourage you to open an issue in this template's repository.
## Learning Storybook
1. Read our introductory tutorial at [Learn Storybook](https://www.learnstorybook.com/intro-to-storybook/angular/en/get-started/).
2. Learn how to transform your component libraries into design systems in our [Design Systems for Developers](https://www.learnstorybook.com/design-systems-for-developers/) tutorial.
2. See our official documentation at [Storybook](https://storybook.js.org/).