@nodeblocks/frontend-list-organization-block 0.4.0 โ 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.esm.js +1 -1
- package/package.json +3 -3
- package/readme.md +0 -64
package/readme.md
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
## ๐ Nodeblocks Frontend Starter Kit
|
|
2
|
-
|
|
3
|
-
Welcome to the Nodeblocks Frontend Starter Kit! ๐ This kit is designed to make building frontend libraries in React super easy, helping you streamline your development workflow with minimal fuss. Let's dive in! ๐คฟ
|
|
4
|
-
|
|
5
|
-
### โจ Features
|
|
6
|
-
|
|
7
|
-
- **๐ Bundling with Rollup:** Get a clean, minimalistic approach to bundling your JavaScript files for smoother frontend development.
|
|
8
|
-
- **๐ TypeScript Support:** We've included a pre-configured `tsconfig.json` to ensure your TypeScript setup is strict, efficient, and ready to go.
|
|
9
|
-
- **โ๏ธ Peer Dependencies:** Keep bundle sizes lean with React and React DOM set as peer dependencies.
|
|
10
|
-
- **๐จ CSS Support:** Easily import and process CSS files, giving you more control over your styles.
|
|
11
|
-
|
|
12
|
-
### ๐ ๏ธ How to Use
|
|
13
|
-
|
|
14
|
-
1. **Clone this repository** ๐:
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
git clone <repository-url>
|
|
18
|
-
cd <repository-directory>
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
2. **Install dependencies** ๐ฆ:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npm install
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
3. **Start development** ๐ ๏ธ:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
npm run watch
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
4. **Build for production** ๐๏ธ:
|
|
34
|
-
```bash
|
|
35
|
-
npm run build
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### ๐งช How to Test
|
|
39
|
-
|
|
40
|
-
The `test` folder contains examples that demonstrate how to use the libraries you create with this starter kit. These examples show compatibility with various bundlers, such as:
|
|
41
|
-
|
|
42
|
-
- **Create React App** (Webpack)
|
|
43
|
-
- **Vite** โก
|
|
44
|
-
- **Rollup** (itself) (Coming soon) ๐
|
|
45
|
-
- **Parcel** (Coming soon) ๐ฆ
|
|
46
|
-
|
|
47
|
-
This ensures Nodeblocks libraries integrate seamlessly with different workflows. ๐ ๏ธโจ
|
|
48
|
-
|
|
49
|
-
**Before running each project make sure you run `npm link`:**
|
|
50
|
-
|
|
51
|
-
1. In the root of this project:
|
|
52
|
-
```bash
|
|
53
|
-
npm link
|
|
54
|
-
```
|
|
55
|
-
2. In the test project you want to run:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
npm i
|
|
59
|
-
npm link @basaldev/frontend-starter-kit
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
(Note that in real life your library would not be called frontend-starter-kit.)
|
|
63
|
-
|
|
64
|
-
3. Then you can follow your usual workflow either with **Create React App** (`npm start`) or with Vite (`npm run dev`). This will give you a development environment where whenever you change your library it will be available in your test project.
|