@area2-ai/a2-demo-cipher-react 0.2.0 → 0.2.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 +3 -101
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,103 +1,5 @@
|
|
|
1
|
-
#
|
|
1
|
+
# A2 Demo Cipher (React)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This repository contains a demo.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
# Install dependencies
|
|
9
|
-
bun install
|
|
10
|
-
|
|
11
|
-
# Start development mode
|
|
12
|
-
bun run dev
|
|
13
|
-
|
|
14
|
-
# Build for production
|
|
15
|
-
bun run build
|
|
16
|
-
|
|
17
|
-
# Run tests
|
|
18
|
-
bun run test
|
|
19
|
-
|
|
20
|
-
# Lint code
|
|
21
|
-
bun run lint
|
|
22
|
-
|
|
23
|
-
# Format code
|
|
24
|
-
bun run format
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Project Structure
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
/src
|
|
31
|
-
index.tsx # Your component entry point
|
|
32
|
-
/test
|
|
33
|
-
index.test.tsx # Tests using Vitest + Testing Library
|
|
34
|
-
/example
|
|
35
|
-
index.tsx # Demo app using Vite
|
|
36
|
-
.gitignore
|
|
37
|
-
package.json
|
|
38
|
-
README.md
|
|
39
|
-
tsconfig.json
|
|
40
|
-
vitest.config.ts
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Scripts
|
|
44
|
-
|
|
45
|
-
| Script | Description |
|
|
46
|
-
|--------|-------------|
|
|
47
|
-
| `bun run dev` | Start development mode with watch |
|
|
48
|
-
| `bun run build` | Build for production |
|
|
49
|
-
| `bun run test` | Run tests |
|
|
50
|
-
| `bun run test:watch` | Run tests in watch mode |
|
|
51
|
-
| `bun run lint` | Lint code |
|
|
52
|
-
| `bun run format` | Format code |
|
|
53
|
-
| `bun run format:check` | Check if code is formatted |
|
|
54
|
-
| `bun run typecheck` | Run TypeScript type checking |
|
|
55
|
-
|
|
56
|
-
## Tools
|
|
57
|
-
|
|
58
|
-
TSDX wraps these modern, high-performance tools:
|
|
59
|
-
|
|
60
|
-
- **[Bunchee](https://github.com/huozhi/bunchee)** - Zero-config bundler for npm packages
|
|
61
|
-
- **[Vitest](https://vitest.dev/)** - Next-generation testing framework
|
|
62
|
-
- **[Testing Library](https://testing-library.com/)** - React testing utilities
|
|
63
|
-
- **[Oxlint](https://oxc.rs/docs/guide/usage/linter.html)** - Rust-powered linter (50-100x faster than ESLint)
|
|
64
|
-
- **[Oxfmt](https://oxc.rs/docs/guide/usage/formatter)** - Rust-powered formatter (35x faster than Prettier)
|
|
65
|
-
- **[TypeScript](https://www.typescriptlang.org/)** - Type safety
|
|
66
|
-
|
|
67
|
-
## Development with Example
|
|
68
|
-
|
|
69
|
-
To test your component in a real React app:
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
# In one terminal, start the library in watch mode
|
|
73
|
-
bun run dev
|
|
74
|
-
|
|
75
|
-
# In another terminal, run the example app
|
|
76
|
-
cd example
|
|
77
|
-
bun install
|
|
78
|
-
bun run dev
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Module Formats
|
|
82
|
-
|
|
83
|
-
This library exports both ESM and CommonJS formats, with full TypeScript support:
|
|
84
|
-
|
|
85
|
-
- `dist/index.js` - ESM
|
|
86
|
-
- `dist/index.cjs` - CommonJS
|
|
87
|
-
- `dist/index.d.ts` - TypeScript declarations
|
|
88
|
-
|
|
89
|
-
## Publishing
|
|
90
|
-
|
|
91
|
-
```bash
|
|
92
|
-
# Build the package
|
|
93
|
-
bun run build
|
|
94
|
-
|
|
95
|
-
# Publish to npm
|
|
96
|
-
npm publish
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
We recommend using [np](https://github.com/sindresorhus/np) for publishing.
|
|
100
|
-
|
|
101
|
-
## License
|
|
102
|
-
|
|
103
|
-
MIT
|
|
5
|
+
For more information, visit the [Area2 page](https://area2.ai/#/contact-us)
|