Skip to content

Commit 8d66bf6

Browse files
committed
added secure elastic readme
1 parent 1a50135 commit 8d66bf6

22 files changed

+32
-751251
lines changed

README.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,43 @@ This dashboard is designed to analyze and visualize data retrieved from an Elast
55

66
## Tech Stack
77

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.
1313

1414
## For Development
15+
1516
To run this dashboard locally, follow these steps:
1617

18+
Node.js Runtime: 18.x or newer;
1719

18-
Node.js Runtime: 18.x or newer;
19-
2020
1. Install dependencies:
2121

22-
2322
```bash
2423
npm install
2524
```
2625

26+
2. Configure Elasticsearch:
2727

28-
2. Configure Elasticsearch:
29-
3028
- Ensure you have Elasticsearch up and running, and configure the data.
3129

32-
33-
3430
3. Start the development server:
3531

3632
```bash
3733
npm run dev
3834
```
3935

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>.
4237

4338
## Folder Structure
4439

4540
Here's the folder structure for the project:
4641

4742
- **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).
4843
- **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.
5145

5246
```csharp
5347

@@ -142,8 +136,7 @@ swamped-dashboard/
142136

143137
```
144138

145-
146-
## Elastic Search Api:
139+
## Elastic Search Api
147140

148141
The Elastic Search API is built using the following technology:
149142

@@ -165,12 +158,10 @@ These apis is called from [`data/api/elastic`](src\data\api\elastic) folder, whi
165158

166159
For example: Check [`this file`](src\domain\store\cities\saga.ts) for saga connection to api related to cities.
167160

168-
169-
170-
171-
## Redux Store:
161+
## Redux Store
172162

173163
### Tech Stack
164+
174165
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/).
175166

176167
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
189180

190181
For other modules you can check into folder [`domain/store/`](/src/domain/store)
191182

192-
## Dashboard Pages:
183+
## Dashboard Pages
193184

194185
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:
195186

@@ -199,10 +190,9 @@ The dashboard consists of several pages, each dedicated to a specific informatio
199190
- **Device Monitor**: Offers real-time monitoring of device status and statistics.
200191
- **Configuration**: Allows users to view and manage setup box configurations.
201192

193+
## UI
202194

203-
## UI:
204-
205-
### Sections:
195+
### Sections
206196

207197
The user interface (UI) of the dashboard is organized into different sections, each responsible for presenting specific data and functionalities. These sections include:
208198

@@ -212,18 +202,10 @@ The user interface (UI) of the dashboard is organized into different sections, e
212202
- **Device Monitor Section**: Displays real-time device monitoring data.
213203
- **Configuration Section**: Provides a user interface for managing setup box configurations.
214204

205+
### Common
215206

216-
### Common:
217-
218-
219-
### Widget:
220-
221-
222-
223-
## Other Parts:
224-
225-
226-
### Dummy Auth API:
227-
207+
### Widget
228208

209+
## Other Parts
229210

211+
### Dummy Auth API
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

ref.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,44 @@
11
# Project
22

3-
- https://github.com/vercel/app-playground/
4-
3+
- <https://github.com/vercel/app-playground/>
54

65
## storybook
76

8-
- https://storybook.js.org/recipes/next
7+
- <https://storybook.js.org/recipes/next>
98

109
## mui
1110

1211
### breakpoints
13-
- https://mui.com/material-ui/customization/breakpoints/
1412

13+
- <https://mui.com/material-ui/customization/breakpoints/>
1514

1615
## ChartJs
1716

18-
- https://episyche.com/blog/how-to-create-charts-using-chart-js-in-next-js
19-
20-
21-
17+
- <https://episyche.com/blog/how-to-create-charts-using-chart-js-in-next-js>
2218

2319
## dashboard
2420

2521
### navigation
2622

27-
- https://codesandbox.io/s/nwrlwq?file=/utils.ts
28-
23+
- <https://codesandbox.io/s/nwrlwq?file=/utils.ts>
2924

3025
## filter
3126

3227
### date range
3328

34-
- https://dev.to/nasreenkhalid/react-date-range-picker-1m1c
35-
29+
- <https://dev.to/nasreenkhalid/react-date-range-picker-1m1c>
3630

3731
### input
38-
- https://codesandbox.io/s/material-ui-input-with-chips-0s2j4
3932

33+
- <https://codesandbox.io/s/material-ui-input-with-chips-0s2j4>
4034

4135
## Geo Location
4236

4337
### Pincode
44-
- https://github.com/sauravazad/pincode
45-
- https://github.com/sanand0/pincode
4638

39+
- <https://github.com/sauravazad/pincode>
40+
- <https://github.com/sanand0/pincode>
4741

4842
### map
4943

50-
- https://github.com/colbyfayock/next-leaflet-starter/blob/main/src/components/Map/DynamicMap.js
44+
- <https://github.com/colbyfayock/next-leaflet-starter/blob/main/src/components/Map/DynamicMap.js>

script/.gitignore

Lines changed: 0 additions & 37 deletions
This file was deleted.

script/city_list.js

Lines changed: 0 additions & 112 deletions
This file was deleted.

0 commit comments

Comments
 (0)