Skip to content

Commit d72c03f

Browse files
committed
Documentation work
1 parent 18c03f7 commit d72c03f

17 files changed

+103
-5
lines changed

Readme.md

+101-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
1+
[![CI (Build 🏗️ & Release 📦)](https://github.com/nooobcoder/HighRadiusTraining/actions/workflows/build_release.yaml/badge.svg?branch=v1.0.0)](https://github.com/nooobcoder/HighRadiusTraining/actions/workflows/build_release.yaml)
2+
3+
---
4+
15
<h1 align="center">Highradius Dashboard 🖥️</h1>
26

3-
*This project is built with React18 support which means it has bleeding edge support of the latest web framework. **To get started in clicks, follow the <a href="#docker-deployment">docker deployment guide</a> below.***
7+
*This project is built with [**React18**](https://reactjs.org/blog/2021/06/08/the-plan-for-react-18.html) support which means it has bleeding edge support of the latest web framework. **To get started in clicks, follow the <a href="#docker-deployment">docker deployment guide</a> below or follow the <a href="#coders-deployment">coder's guide (advanced)</a>.***
48

59
![Dashboard Screenshot](Screenshots/Dashboard_scr_1.png)
610

711
> [Screenshots](Screenshots)
812
913
---
1014

11-
<h2>Project Status</h2>
15+
<h2 class="code-line" data-line-start=0 data-line-end=1 ><a id="Project_Milestone_0"></a>Project Milestone</h2>
16+
<p class="has-line-data" data-line-start="2" data-line-end="4">The mandatory features are compulsory tasks and the optional features are for<br>
17+
extra credit points, which will give you an added advantage.</p>
18+
<table class="table table-striped table-bordered">
19+
<thead>
20+
<tr>
21+
<th>Mandatory Features</th>
22+
<th>Optional Features</th>
23+
</tr>
24+
</thead>
25+
<tbody>
26+
<tr>
27+
<td><input type="checkbox" id="checkbox56" checked="true"><label for="checkbox56">1. UI Creation</label></td>
28+
<td><input type="checkbox" id="checkbox57" checked="true"><label for="checkbox57">1. Predict Button activation with Grid Data</label></td>
29+
</tr>
30+
<tr>
31+
<td><input type="checkbox" id="checkbox58" checked="true"><label for="checkbox58">2. Grid Creation</label></td>
32+
<td><input type="checkbox" id="checkbox59" checked="true"><label for="checkbox59">2. Shortcut search button on Grid for Customer Id</label></td>
33+
</tr>
34+
<tr>
35+
<td><input type="checkbox" id="checkbox60" checked="true"><label for="checkbox60">3. Grid Data Loading</label></td>
36+
<td><input type="checkbox" id="checkbox61"><label for="checkbox61">3. Sorting columns</label></td>
37+
</tr>
38+
<tr>
39+
<td><input type="checkbox" id="checkbox62" checked="true"><label for="checkbox62">4. Crud Operation (ADD/EDIT/DEL)</label></td>
40+
<td><input type="checkbox" id="checkbox63" checked="true"><label for="checkbox63" >4. View - Analytics</label></td>
41+
</tr>
42+
<tr>
43+
<td><input type="checkbox" id="checkbox64" checked="true"><label for="checkbox64">5. Pagination</label></td>
44+
<td></td>
45+
</tr>
46+
<tr>
47+
<td><input type="checkbox" id="checkbox65" checked="true"><label for="checkbox65">6. Advanced Search</label></td>
48+
<td></td>
49+
</tr>
50+
</tbody>
51+
</table>
52+
<br/>
1253

13-
[![CI (Build 🏗️ & Release 📦)](https://github.com/nooobcoder/HighRadiusTraining/actions/workflows/build_release.yaml/badge.svg?branch=v1.0.0)](https://github.com/nooobcoder/HighRadiusTraining/actions/workflows/build_release.yaml)
1454

1555
---
1656

@@ -41,6 +81,15 @@
4181

4282
- [Github Actions](https://github.com/features/actions)
4383

84+
### 4. Development Tools
85+
- [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/business/) (Ultimate is necessary for JavaEE projects and tomcat servers configuration.)
86+
![](Screenshots/intellij_screenshot.png)
87+
- [Raspberry Pi](https://www.raspberrypi.org/)
88+
![](Screenshots/raspi.jpeg)
89+
- [Gitpod OpenVSCode Server](https://github.com/gitpod-io/openvscode-server) ([For air gapped development environment](https://coder.com/docs/coder/latest/setup/air-gapped).)
90+
![](Screenshots/openvscode_server.png)
91+
- [Postman for API Testing](https://www.postman.com/)
92+
![](Screenshots/postman.jpg)
4493
---
4594

4695
<h2> Getting Started </h2>
@@ -161,6 +210,55 @@ Once the images are built, you can **start the containers** from the docker-comp
161210

162211
---
163212

213+
<h3> ⚠️ ADVANCED Deployment </h3>
214+
<h4 id="coders-deployment"> Coder's Guide </h4>
215+
216+
<h5> 1. Backend Setup </h5>
217+
218+
- Open the <a href="Track%204_ReactJS_Web%20Development/Project/Backend/API/demo/" target="_blank">backend project</a> in your favorite IDE like <a href="https://www.jetbrains.com/idea/business/" target="_blank">IntelliJ IDEA</a> or <a href="https://www.eclipse.org/" target="_blank">Eclipse</a>.
219+
220+
You would get a similar folder structure for the <a href="Track%204_ReactJS_Web%20Development/Project/Backend/API/demo/" target="_blank">**backend project**</a>.
221+
![](Screenshots/servlet_project_structure.png)
222+
223+
- Bootstrap/Prepare Tomcat as per your IDE.
224+
225+
- In IntelliJ IDEA you can see the build configuration here and perform the build server setup following the images below.
226+
227+
1. ![1](Screenshots/build_1.png)
228+
2. ![2](Screenshots/build_2.png)
229+
3. ![3](Screenshots/build_3.png)
230+
4. ![4](Screenshots/build_4.png)
231+
5. ![5](Screenshots/build_5.png)
232+
6. ![6](Screenshots/build_6.png)
233+
7. ![6](Screenshots/build_7.png)
234+
235+
236+
<h5> 2. Frontend Setup </h5>
237+
238+
1. Folder Structure
239+
240+
![1](Screenshots/build_8.png)
241+
242+
2. Install the dependencies
243+
244+
![2](Screenshots/yarn_install_success.png)
245+
246+
3. Copy the <a href="Track%204_ReactJS_Web%20Development/Project/Frontend/hrc-dashboard/.env.example" target="_blank">`.env.example`</a> -> `.env.local` and tweak the **env variables** as per your setup.
247+
248+
![3](Screenshots/build_9.png)
249+
250+
4. Run <a href="Track%204_ReactJS_Web%20Development/Project/Frontend/hrc-dashboard/package.json" target="_blank">`yarn serve`</a> in the terminal (**script source from package.json**).
251+
252+
![4](Screenshots/build_10.png)
253+
254+
<h5> 3. Postman Setup </h5>
255+
256+
Please [import](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) the followings for Postman to auto import the api endpoints
257+
258+
1. <a href="Track%204_ReactJS_Web%20Development/Project/Postman%20Collection/HighradiusWinterInternship.postman_collection.json" target="_blank">API Endpoint Folder</a>
259+
2. <a href="Track%204_ReactJS_Web%20Development/Project/Postman%20Collection/HighRadius%20Training.postman_environment.json" target="_blank">Environment Variables</a>
260+
---
261+
164262
## HighRadius Training Details
165263

166264
<p>Dear Student,

Screenshots/build_1.png

9.39 KB
Loading

Screenshots/build_10.png

32.9 KB
Loading

Screenshots/build_2.png

10.1 KB
Loading

Screenshots/build_3.png

59.2 KB
Loading

Screenshots/build_4.png

38.7 KB
Loading

Screenshots/build_5.png

9.49 KB
Loading

Screenshots/build_6.png

185 KB
Loading

Screenshots/build_7.png

11.7 KB
Loading

Screenshots/build_8.png

137 KB
Loading

Screenshots/build_9.png

37.9 KB
Loading

Screenshots/intellij_screenshot.png

69.4 KB
Loading

Screenshots/openvscode_server.png

138 KB
Loading

Screenshots/postman.jpg

376 KB
Loading

Screenshots/raspi.jpeg

68.5 KB
Loading
93.8 KB
Loading

Track 4_ReactJS_Web Development/Project/Frontend/hrc-dashboard/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ extra credit points, which will give you an added advantage.</p>
2323
</tr>
2424
<tr>
2525
<td><input type="checkbox" id="checkbox62" checked="true"><label for="checkbox62">4. Crud Operation (ADD/EDIT/DEL)</label></td>
26-
<td><input type="checkbox" id="checkbox63"><label for="checkbox63">4. View - Analytics</label></td>
26+
<td><input type="checkbox" id="checkbox63" checked="true"><label for="checkbox63" >4. View - Analytics</label></td>
2727
</tr>
2828
<tr>
29-
<td><input type="checkbox" id="checkbox64"><label for="checkbox64">5. Pagination</label></td>
29+
<td><input type="checkbox" id="checkbox64" checked="true"><label for="checkbox64">5. Pagination</label></td>
3030
<td></td>
3131
</tr>
3232
<tr>

0 commit comments

Comments
 (0)