create-bluecopa-react-app 1.0.1 → 1.0.3
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 +144 -53
- package/bin/create-bluecopa-react-app.js +4 -4
- package/package.json +2 -2
- package/templates/latest/Agent.md +288 -0
- package/templates/latest/README.md +31 -9
- package/templates/latest/package-lock.json +282 -134
- package/templates/latest/package.json +3 -7
- package/templates/latest/preview/index.html +330 -0
- package/templates/latest/vite.config.ts +18 -31
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BlueCopa React App Template
|
|
2
2
|
|
|
3
|
-
A production-ready React template with React Router for building modern
|
|
3
|
+
A production-ready React template with React Router for building modern BlueCopa dashboard applications with integrated React hooks, beautiful UI components, and comprehensive data visualization capabilities.
|
|
4
4
|
|
|
5
5
|
## 🎨 Design System
|
|
6
6
|
|
|
@@ -14,6 +14,23 @@ This template now uses the latest Bluecopa design system with:
|
|
|
14
14
|
|
|
15
15
|
## 🚀 Quick Start
|
|
16
16
|
|
|
17
|
+
> **Note**: This template is typically generated using the `create-bluecopa-react-app` CLI tool. If you're using this template directly, follow the manual setup instructions below.
|
|
18
|
+
|
|
19
|
+
### Using the CLI Tool (Recommended)
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Install globally
|
|
23
|
+
npm install -g create-bluecopa-react-app
|
|
24
|
+
|
|
25
|
+
# Create new app
|
|
26
|
+
create-bluecopa-react-app my-dashboard
|
|
27
|
+
|
|
28
|
+
# Or use npx
|
|
29
|
+
npx create-bluecopa-react-app my-dashboard
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Manual Setup
|
|
33
|
+
|
|
17
34
|
### Prerequisites
|
|
18
35
|
- Node.js 18+
|
|
19
36
|
- npm or pnpm
|
|
@@ -24,10 +41,10 @@ This template now uses the latest Bluecopa design system with:
|
|
|
24
41
|
1. **Clone or copy the template**:
|
|
25
42
|
```bash
|
|
26
43
|
# If using as part of the blui monorepo
|
|
27
|
-
cd packages/boilerplate/react/templates/
|
|
44
|
+
cd packages/boilerplate/react/templates/latest
|
|
28
45
|
|
|
29
46
|
# Or copy the template to your project location
|
|
30
|
-
cp -r packages/boilerplate/react/templates/
|
|
47
|
+
cp -r packages/boilerplate/react/templates/latest my-bluecopa-app
|
|
31
48
|
cd my-bluecopa-app
|
|
32
49
|
```
|
|
33
50
|
|
|
@@ -95,9 +112,11 @@ This template now uses the latest Bluecopa design system with:
|
|
|
95
112
|
|
|
96
113
|
```
|
|
97
114
|
src/
|
|
98
|
-
├── components/ # Reusable
|
|
99
|
-
│ ├──
|
|
100
|
-
│
|
|
115
|
+
├── components/ # Reusable components
|
|
116
|
+
│ ├── layout/ # Layout components (dashboard-header.tsx, dashboard-layout.tsx, sidebar.tsx)
|
|
117
|
+
│ ├── page/ # Page-specific components (dashboard.tsx, navbar.tsx)
|
|
118
|
+
│ ├── tables/ # Table components (data-grid.tsx)
|
|
119
|
+
│ └── ui/ # Base UI components (alert.tsx, avatar.tsx, badge.tsx, bluecopa-logo.tsx, button.tsx, card.tsx, dropdown-menu.tsx, input.tsx, label.tsx, select.tsx)
|
|
101
120
|
├── hooks/ # Custom React hooks
|
|
102
121
|
│ └── use-api.ts # Bluecopa API hooks
|
|
103
122
|
├── lib/ # Utility functions
|
|
@@ -108,9 +127,12 @@ src/
|
|
|
108
127
|
├── providers/ # React context providers
|
|
109
128
|
│ └── query-provider.tsx # TanStack Query provider
|
|
110
129
|
├── types/ # TypeScript type definitions
|
|
130
|
+
│ └── api.ts # API type definitions
|
|
111
131
|
├── App.tsx # Main app component with routing
|
|
132
|
+
├── index.css # Global styles
|
|
112
133
|
├── main.tsx # Application entry point
|
|
113
|
-
|
|
134
|
+
├── single-spa.tsx # Single-spa configuration
|
|
135
|
+
└── vite-env.d.ts # Vite environment types
|
|
114
136
|
```
|
|
115
137
|
|
|
116
138
|
## 🔧 Configuration
|
|
@@ -161,7 +183,7 @@ export default function App() {
|
|
|
161
183
|
```
|
|
162
184
|
|
|
163
185
|
### Adding Navigation Links
|
|
164
|
-
Update the navigation in `src/components/navbar.tsx`:
|
|
186
|
+
Update the navigation in `src/components/page/navbar.tsx`:
|
|
165
187
|
|
|
166
188
|
```tsx
|
|
167
189
|
const navigation = [
|