@owox/web 0.5.0
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 +89 -0
- package/dist/assets/index-B0iEzOlj.js +683 -0
- package/dist/assets/index-BhDmWiyF.css +1 -0
- package/dist/favicon.png +0 -0
- package/dist/index.html +14 -0
- package/package.json +83 -0
package/README.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Web Application
|
|
2
|
+
|
|
3
|
+
This is the web interface for OWOX Data Marts - an open-source solution for Data Analysts. This web application provides a user-friendly interface for managing Data Marts.
|
|
4
|
+
|
|
5
|
+
## Technologies Used
|
|
6
|
+
|
|
7
|
+
- **React**: v19.1.0 - UI library for building the user interface
|
|
8
|
+
- **TypeScript**: v5.7.3 - For type-safe JavaScript development
|
|
9
|
+
- **Tailwind CSS**: v4.1.8 - For utility-first styling
|
|
10
|
+
- **Vite**: v6.3.5 - For fast development and optimized builds
|
|
11
|
+
- **Node.js packages**: Various dependencies for UI components and development tools
|
|
12
|
+
|
|
13
|
+
## Project Structure
|
|
14
|
+
|
|
15
|
+
The project follows a monorepo structure using npm workspaces.
|
|
16
|
+
|
|
17
|
+
## Getting Started
|
|
18
|
+
|
|
19
|
+
### Prerequisites
|
|
20
|
+
|
|
21
|
+
- Node.js (latest LTS version recommended)
|
|
22
|
+
- npm (comes with Node.js)
|
|
23
|
+
|
|
24
|
+
### Installation
|
|
25
|
+
|
|
26
|
+
1. Clone the repository:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
git clone https://github.com/OWOX/owox-data-marts.git
|
|
30
|
+
cd owox-data-marts
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
2. Install dependencies:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm install
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Development
|
|
40
|
+
|
|
41
|
+
To start the development server:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# From the root directory to run all workspaces:
|
|
45
|
+
npm run dev
|
|
46
|
+
|
|
47
|
+
# Or to run just the web app:
|
|
48
|
+
cd apps/web
|
|
49
|
+
npm run dev
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
The application will be available at `http://localhost:5173` (or another port if 5173 is already in use).
|
|
53
|
+
|
|
54
|
+
### Building for Production
|
|
55
|
+
|
|
56
|
+
To create a production build:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# From the root directory:
|
|
60
|
+
cd apps/web
|
|
61
|
+
npm run build
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The built files will be in the `apps/web/dist` directory.
|
|
65
|
+
|
|
66
|
+
To preview the production build:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npm run preview
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Available Scripts
|
|
73
|
+
|
|
74
|
+
- `npm run dev` - Start the development server
|
|
75
|
+
- `npm run build` - Build for production
|
|
76
|
+
- `npm run lint` - Run ESLint
|
|
77
|
+
- `npm run lint:fix` - Run ESLint with automatic fixes
|
|
78
|
+
- `npm run format` - Format code with Prettier
|
|
79
|
+
- `npm run format:check` - Check code formatting
|
|
80
|
+
- `npm run preview` - Preview the production build
|
|
81
|
+
|
|
82
|
+
## Related Documentation
|
|
83
|
+
|
|
84
|
+
- For information about the overall project, see the [main README](../../README.md)
|
|
85
|
+
- For UI components documentation, check the `/packages/ui`
|
|
86
|
+
|
|
87
|
+
## Contributing
|
|
88
|
+
|
|
89
|
+
Contributions are welcome! Please see the [Contributor guide](../../packages/connectors/CONTRIBUTING.md) for details on how to contribute to the project.
|