1
1
# Yail
2
2
3
- [ ![ lint-and-test-pr] ( https://github.com/Programmer-Network/yail/actions/workflows/lint-and-test.yaml/badge.svg )] ( https://github.com/Programmer-Network/yail/actions/workflows/lint-and-test.yaml )
4
- [ ![ pages-build-deployment] ( https://github.com/Programmer-Network/yail/actions/workflows/pages/pages-build-deployment/badge.svg )] ( https://github.com/Programmer-Network/yail/actions/workflows/pages/pages-build-deployment )
5
- [ ![ deploy-storybook] ( https://github.com/Programmer-Network/yail/actions/workflows/deploy-storybook.yaml/badge.svg )] ( https://github.com/Programmer-Network/yail/actions/workflows/deploy-storybook.yaml )
3
+ [ ![ lint-and-test-pr] ( https://github.com/Programmer-Network/yail/actions/workflows/ci.yaml/badge.svg )] ( https://github.com/Programmer-Network/yail/actions/workflows/ci.yaml )
6
4
7
5
<p align =" center " >
8
6
<img src =" ./assets/images/yail-logo.png " >
@@ -48,38 +46,41 @@ Before you begin, ensure you have met the following requirements:
48
46
the project directory.
49
47
- [ pnpm] ( https://pnpm.io/ ) : Install pnpm globally with ` npm install -g pnpm ` .
50
48
51
-
52
49
## Getting Started
53
50
54
51
### Usage
55
52
56
53
#### Installation
57
54
58
- To integrate Yail into your project, install it using your preferred package manager. For example, with ` pnpm ` , you can add it as follows:
55
+ To integrate Yail into your project, install it using your preferred package
56
+ manager. For example, with ` pnpm ` , you can add it as follows:
59
57
60
58
``` bash
61
59
pnpm add @programmer_network/yail
62
60
```
63
61
64
62
#### Incorporating Components into Your Project
65
63
66
- After installation, you can start using Yail components in your React project. Here's how you can import a component:
64
+ After installation, you can start using Yail components in your React project.
65
+ Here's how you can import a component:
67
66
68
67
``` jsx
69
68
import { Button } from " @programmer_network/yail" ;
70
69
```
71
70
72
71
#### Exploring Components with Storybook
73
72
74
- Yail provides a comprehensive component showcase through Storybook. To explore these components, start the Storybook server:
73
+ Yail provides a comprehensive component showcase through Storybook. To explore
74
+ these components, start the Storybook server:
75
75
76
76
``` bash
77
77
pnpm storybook
78
78
```
79
79
80
80
## Contributing to Yail
81
81
82
- We welcome contributions to Yail! Here's how you can set up the project locally for development.
82
+ We welcome contributions to Yail! Here's how you can set up the project locally
83
+ for development.
83
84
84
85
### Setting Up the Development Environment
85
86
@@ -108,7 +109,8 @@ To start the development server, run:
108
109
pnpm dev
109
110
```
110
111
111
- This command will launch Vite's development server. You can then make changes to the library, and Vite will automatically reload these changes.
112
+ This command will launch Vite's development server. You can then make changes to
113
+ the library, and Vite will automatically reload these changes.
112
114
113
115
View your changes inside storybook:
114
116
@@ -134,7 +136,8 @@ pnpm test:watch
134
136
135
137
### Linting and Code Formatting
136
138
137
- To ensure code consistency, we use ESLint and Prettier. Run these before committing your changes:
139
+ To ensure code consistency, we use ESLint and Prettier. Run these before
140
+ committing your changes:
138
141
139
142
** To lint your code:**
140
143
@@ -155,8 +158,9 @@ Once you've made your changes:
155
158
1 . Fork the repository.
156
159
2 . Create a new branch for your changes.
157
160
3 . Commit your changes and push them to your fork.
158
- 4 . Open a pull request against the ` main ` branch of the ` Programmer-Network/yail ` repository.
161
+ 4 . Open a pull request against the ` main ` branch of the
162
+ ` Programmer-Network/yail ` repository.
159
163
160
164
Please provide a clear description of the changes in your pull request.
161
165
162
- Thank you for contributing to Yail!
166
+ Thank you for contributing to Yail!
0 commit comments