arbor-dashboard 1.4.0 → 1.41.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.
Files changed (7) hide show
  1. package/README.md +58 -0
  2. package/dist/barChart.js +1 -1
  3. package/dist/dashboard.js +1 -1
  4. package/dist/heatMap.js +1 -1
  5. package/dist/lineChart.js +1 -1
  6. package/dist/main.js +1 -1
  7. package/package.json +10 -8
package/README.md CHANGED
@@ -1,2 +1,60 @@
1
1
  # data.responsive_charting_dashboards
2
+
2
3
  An npm package of responsive charting components for data visualisation
4
+
5
+ ## Getting Started
6
+
7
+ ### Prerequisites
8
+
9
+ - Node.js
10
+ - Yarn package manager
11
+
12
+ ### Installation
13
+
14
+ 1. Clone the repository and install dependencies:
15
+
16
+ ```bash
17
+ yarn
18
+ ```
19
+
20
+ 2. Install backend dependencies:
21
+ ```bash
22
+ cd local/backend
23
+ yarn
24
+ ```
25
+
26
+ 3. Install frontend dependencies:
27
+ ```bash
28
+ cd local/Frontend
29
+ yarn
30
+ ```
31
+
32
+ ### Running the Backend
33
+
34
+ 1. Navigate to the backend directory:
35
+ ```bash
36
+ cd local/backend
37
+ ```
38
+
39
+ 2. Start the backend server:
40
+ ```bash
41
+ node app.js
42
+ ```
43
+
44
+ 4. Verify the backend is running by visiting:
45
+ http://localhost:3000/
46
+
47
+ ### Running the Frontend
48
+
49
+ 1. Navigate to the frontend directory:
50
+ ```bash
51
+ cd local/Frontend
52
+ ```
53
+
54
+ 2. Start the Frontend
55
+ ```bash
56
+ npm run dev
57
+ ```
58
+
59
+ 3. The frontend will be available at:
60
+ http://localhost:5173/