You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-38Lines changed: 20 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,49 +5,43 @@ This dashboard is designed to analyze and visualize data retrieved from an Elast
5
5
6
6
## Tech Stack
7
7
8
-
- Next.js - A React framework for server-rendered applications.
9
-
- UI Library - @mui/joy for building user interfaces.
10
-
- State Management - Redux and Redux-Saga for managing application state.
11
-
- Charts - Chart.js and Highcharts for data visualization.
12
-
-@elastic/elasticsearch - JavaScript client for Elasticsearch.
8
+
- Next.js - A React framework for server-rendered applications.
9
+
- UI Library - @mui/joy for building user interfaces.
10
+
- State Management - Redux and Redux-Saga for managing application state.
11
+
- Charts - Chart.js and Highcharts for data visualization.
12
+
-@elastic/elasticsearch - JavaScript client for Elasticsearch.
13
13
14
14
## For Development
15
+
15
16
To run this dashboard locally, follow these steps:
16
17
18
+
Node.js Runtime: 18.x or newer;
17
19
18
-
Node.js Runtime: 18.x or newer;
19
-
20
20
1. Install dependencies:
21
21
22
-
23
22
```bash
24
23
npm install
25
24
```
26
25
26
+
2. Configure Elasticsearch:
27
27
28
-
2. Configure Elasticsearch:
29
-
30
28
- Ensure you have Elasticsearch up and running, and configure the data.
31
29
32
-
33
-
34
30
3. Start the development server:
35
31
36
32
```bash
37
33
npm run dev
38
34
```
39
35
40
-
This command will start the Next.js development server, and you can access the dashboard in your browser at http://localhost:3000.
41
-
36
+
This command will start the Next.js development server, and you can access the dashboard in your browser at <http://localhost:3000>.
42
37
43
38
## Folder Structure
44
39
45
40
Here's the folder structure for the project:
46
41
47
42
-**app/:** Next.js navigation related folder representing different sections of the `dashboard` and server side `api` related to elastic search and auth. For more detail [see here](https://nextjs.org/docs/app/building-your-application/routing).
48
43
-**data/:** This directory contains the API repository and any data-related files.
49
-
-**domain/:** Here we put business logics. In the domain folder we have [Redux Store](#redux-store) and module specific folder.
50
-
44
+
-**domain/:** Here we put business logics. In the domain folder we have [Redux Store](#redux-store) and module specific folder.
51
45
52
46
```csharp
53
47
@@ -142,8 +136,7 @@ swamped-dashboard/
142
136
143
137
```
144
138
145
-
146
-
## Elastic Search Api:
139
+
## Elastic Search Api
147
140
148
141
The Elastic Search API is built using the following technology:
149
142
@@ -165,12 +158,10 @@ These apis is called from [`data/api/elastic`](src\data\api\elastic) folder, whi
165
158
166
159
For example: Check [`this file`](src\domain\store\cities\saga.ts) for saga connection to api related to cities.
167
160
168
-
169
-
170
-
171
-
## Redux Store:
161
+
## Redux Store
172
162
173
163
### Tech Stack
164
+
174
165
The project uses Redux, a predictable state container for webapp, to manage state. You can learn more about Redux in the [official Redux documentation](https://redux.js.org/).
175
166
176
167
The Redux store in the project is built using the following technologies:
@@ -189,7 +180,7 @@ Each module within the `store/` directory represents a specific part of your app
189
180
190
181
For other modules you can check into folder [`domain/store/`](/src/domain/store)
191
182
192
-
## Dashboard Pages:
183
+
## Dashboard Pages
193
184
194
185
The dashboard consists of several pages, each dedicated to a specific information of the setup box data analysis. This is made according to nextJs navigation [more detail here](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts). Here's an overview of the available dashboard pages:
195
186
@@ -199,10 +190,9 @@ The dashboard consists of several pages, each dedicated to a specific informatio
199
190
-**Device Monitor**: Offers real-time monitoring of device status and statistics.
200
191
-**Configuration**: Allows users to view and manage setup box configurations.
201
192
193
+
## UI
202
194
203
-
## UI:
204
-
205
-
### Sections:
195
+
### Sections
206
196
207
197
The user interface (UI) of the dashboard is organized into different sections, each responsible for presenting specific data and functionalities. These sections include:
208
198
@@ -212,18 +202,10 @@ The user interface (UI) of the dashboard is organized into different sections, e
0 commit comments