File tree 1 file changed +20
-4
lines changed
1 file changed +20
-4
lines changed Original file line number Diff line number Diff line change @@ -115,10 +115,12 @@ export default function Index() {
115
115
116
116
[ ` pheralb/toast ` ] ( https://github.com/pheralb/toast ) is a monorepo built with [ Turbo] ( https://turbo.build/repo ) and it uses:
117
117
118
- - [ ** Library** ] ( https://github.com/pheralb/toast/tree/main/library ) : React 18 with tsup.
118
+ - [ ** Library** ] ( https://github.com/pheralb/toast/tree/main/library ) : React 18 with tsup + Vitest for testing .
119
119
- [ ** Website** ] ( https://github.com/pheralb/toast/tree/main/website ) : Remix, shadcn/ui + Tailwind CSS + Radix & MDX.
120
+ - [ ** Example** ] ( https://github.com/pheralb/toast/tree/main/example ) : Next.js 14 /app project with Tailwind CSS to test the library.
120
121
121
122
1 . [ Click here to fork] ( https://github.com/pheralb/toast/fork ) the repository.
123
+
122
124
2 . Install dependencies:
123
125
124
126
``` bash
@@ -129,14 +131,28 @@ npm install -g pnpm
129
131
pnpm install
130
132
```
131
133
132
- 3 . Run monorepo :
134
+ 3 . Commands :
133
135
134
- ```
136
+ ``` bash
137
+ # Run the development server:
135
138
pnpm dev
139
+
140
+ # Build the docs & library:
141
+ pnpm build
142
+
143
+ # Test the library:
144
+ pnpm test
136
145
```
137
146
147
+ - Open [ ` http://localhost:5173 ` ] ( http://localhost:5173 ) to view the documentation website.
148
+ - Open [ ` http://localhost:3000 ` ] ( http://localhost:3000 ) to view the playground. Test the functionality of the library.
149
+
138
150
and create a pull request with your features or fixes 🚀✨.
139
151
152
+ <a href =" https://github.com/pheralb/toast/graphs/contributors " >
153
+ <img src =" https://contrib.rocks/image?repo=pheralb/toast " />
154
+ </a >
155
+
140
156
## 📃 License
141
157
142
- - [ MIT License] ( https://github.com/pheralb/toast/blob/main/LICENSE ) .
158
+ [ MIT License] ( https://github.com/pheralb/toast/blob/main/LICENSE ) - [ ** pheralb ** ] ( https://pheralb.dev ) 2024 .
You can’t perform that action at this time.
0 commit comments