docs changes

4 files changed, 111 insertions, 216 deletions

diff --git a/admin/README.md b/admin/README.md
deleted file mode 100644
index 58beeac..0000000
--- a/admin/README.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
-
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
diff --git a/client/README.md b/client/README.md
deleted file mode 100644
index 58beeac..0000000
--- a/client/README.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
-
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
diff --git a/docs/README.md b/docs/README.md
index 053f19d..311f118 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,76 +1,36 @@
-//starting will be done by rohan 

-# Tech Stack for the Web App

-ReactJS– Frontend of Web App

-

-Node.js – Backend of Web App

-

-MongoDB – Database management system

-

-Windows/Linux – Operating System

-

-# Hardware Dependencies/Components for implementing the Kiosk

-- Touch screen Display

-- Camera - For capturing Photographs

-- SD Card - Storage for the Kiosk.

-- Raspberry Pi 4 - Main control board of Kiosk.

-- Document Scanner -To scan user documents.

-- Fingerprint & Iris Scanner- For biometric verification

-- Kiosk Container - To integrate and setup the entire kiosk components.

-

-

-# Workflow And Use Cases of our Web app

-

-###### Case 1 : Enrollment

-

-Applicant will go through a series of fields/forms in kiosk in which they have to fill their personal details, scan their bio-metrics and necessary documents. After all the details are provided, the applicant will be provided an OTP & EID will be generated.

-

-###### Case 2 : Update

-In this scenario the applicants will enter their Aadhaar No., then their details will be fetched from the database and the fields will be pre-populated. After that they can select & update their required details through the kiosk.

-###### Case 3 : Check Status

-In this Scenario the user will enter its genrated **Eid which will** after which he will be able to view its application status that can be in progress, Accepted, Rejected 

-

-# Web App Modules

--Erollment

-

--Update

-

--Check Status

-

--ADMIN- apart from the above 3 components that will be visible to front user we will be also having a admin access module component that will verify the coming enrollment and update requests from the applicants based on which the *Check Status* module will update the status of the application to the end user.

-

-## Each Module Explain in detail Rohan/Venkatesh this should be covering every minute detail as possible

-

-# Integration of the web app in the hardware

-## Rasberry Pi

-###### Setting up the Raspberry Pi

-

-To get started with your Raspberry Pi computer you'll need the following accessories:

-

-A computer monitor, or television. Most should work as a display for the Raspberry Pi, but for best results, you should use a display with HDMI input. You'll also need an appropriate display cable, to connect  monitor to  Raspberry Pi.

-

-A computer keyboard and mouse

-

- * Any standard USB keyboard and mouse will work with Raspberry Pi.

- * Wireless keyboards and mice will work if already paired.

-

-

-A good quality Power Supply

-Finally we'll  need an SD card; we recommend a minimum of 8GB micro SD card, and to use the Raspberry Pi Imager to install an operating system onto it. 

-###### Connecting a Display

-. plug the Raspberry Pi in to a display: either a computer monitor, or a television.

-. For monitors with a DVI port, you can use an HDMI-to-DVI cable, or an HDMI cable with a DVI adapter. For older monitors that only support VGA, you can use an HDMI-to-VGA adapter.

-

-Next we will be installing our operating system onto it that will be linux and then will finally install our web app onto it.

-

-## Kernel Setup - Linux

-The Raspberry Pi kernel is stored in GitHub and can be viewed at https://github.com/raspberrypi/linux[github.com/raspberrypi/linux];

-###### Getting Code In the Kernel

-

-## setting ingerprint and iris module No idea/////////

-

-

-

-## Camera Module

-###### Connecting the Camera

-The flex cable inserts into the connector labelled CAMERA on the Raspberry Pi, which is located between the Ethernet and HDMI ports. The cable must be inserted with the silver contacts facing the HDMI port. To open the connector, pull the tabs on the top of the connector upwards, then towards the Ethernet port. The flex cable should be inserted firmly into the connector, with care taken not to bend the flex at too acute an angle. To close the connector, push the top part of the connector towards the HDMI port and down, while holding the flex cable in place.

-

+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn`
+Install all the required dependencies from the `package.json`. Ensure that you have done this step, otherwise the app will have errors.
+
+Note : If you don't have `yarn` installed on your system, kindly refer to the official doc -> https://classic.yarnpkg.com/en/docs/install#debian-stable
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+
+The page will reload when you make changes.\
+You may also see any lint errors in the console.
+
+### `yarn run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+
+If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+
+You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
diff --git a/docs/TECH.md b/docs/TECH.md
new file mode 100644
index 0000000..437bce5
--- /dev/null
+++ b/docs/TECH.md
@@ -0,0 +1,75 @@
+# Tech Stack for the Web App

+ReactJS– Frontend of Web App

+

+Node.js – Backend of Web App

+

+MongoDB – Database management system

+

+Windows/Linux – Operating System

+

+# Hardware Dependencies/Components for implementing the Kiosk

+- Touch screen Display

+- Camera - For capturing Photographs

+- SD Card - Storage for the Kiosk.

+- Raspberry Pi 4 - Main control board of Kiosk.

+- Document Scanner -To scan user documents.

+- Fingerprint & Iris Scanner- For biometric verification

+- Kiosk Container - To integrate and setup the entire kiosk components.

+

+

+# Workflow And Use Cases of our Web app

+

+###### Case 1 : Enrollment

+

+Applicant will go through a series of fields/forms in kiosk in which they have to fill their personal details, scan their bio-metrics and necessary documents. After all the details are provided, the applicant will be provided an OTP & EID will be generated.

+

+###### Case 2 : Update

+In this scenario the applicants will enter their Aadhaar No., then their details will be fetched from the database and the fields will be pre-populated. After that they can select & update their required details through the kiosk.

+###### Case 3 : Check Status

+In this Scenario the user will enter its genrated **Eid which will** after which he will be able to view its application status that can be in progress, Accepted, Rejected 

+

+# Web App Modules

+-Erollment

+

+-Update

+

+-Check Status

+

+-ADMIN- apart from the above 3 components that will be visible to front user we will be also having a admin access module component that will verify the coming enrollment and update requests from the applicants based on which the *Check Status* module will update the status of the application to the end user.

+

+## Each Module Explain in detail Rohan/Venkatesh this should be covering every minute detail as possible

+

+# Integration of the web app in the hardware

+## Rasberry Pi

+###### Setting up the Raspberry Pi

+

+To get started with your Raspberry Pi computer you'll need the following accessories:

+

+A computer monitor, or television. Most should work as a display for the Raspberry Pi, but for best results, you should use a display with HDMI input. You'll also need an appropriate display cable, to connect  monitor to  Raspberry Pi.

+

+A computer keyboard and mouse

+

+ * Any standard USB keyboard and mouse will work with Raspberry Pi.

+ * Wireless keyboards and mice will work if already paired.

+

+

+A good quality Power Supply

+Finally we'll  need an SD card; we recommend a minimum of 8GB micro SD card, and to use the Raspberry Pi Imager to install an operating system onto it. 

+###### Connecting a Display

+. plug the Raspberry Pi in to a display: either a computer monitor, or a television.

+. For monitors with a DVI port, you can use an HDMI-to-DVI cable, or an HDMI cable with a DVI adapter. For older monitors that only support VGA, you can use an HDMI-to-VGA adapter.

+

+Next we will be installing our operating system onto it that will be linux and then will finally install our web app onto it.

+

+## Kernel Setup - Linux

+The Raspberry Pi kernel is stored in GitHub and can be viewed at https://github.com/raspberrypi/linux[github.com/raspberrypi/linux];

+###### Getting Code In the Kernel

+

+## setting fingerprint and iris module No idea/////////

+

+

+

+## Camera Module

+###### Connecting the Camera

+The flex cable inserts into the connector labeled CAMERA on the Raspberry Pi, which is located between the Ethernet and HDMI ports. The cable must be inserted with the silver contacts facing the HDMI port. To open the connector, pull the tabs on the top of the connector upwards, then towards the Ethernet port. The flex cable should be inserted firmly into the connector, with care taken not to bend the flex at too acute an angle. To close the connector, push the top part of the connector towards the HDMI port and down, while holding the flex cable in place.

+