From c40216c1126ad8e39d0d53175871fd9b672d7283 Mon Sep 17 00:00:00 2001 From: Akhilender Bongirwar Date: Wed, 5 Mar 2025 12:36:42 +0530 Subject: [PATCH] feat: add readme and License for our project Signed-off-by: Akhilender Bongirwar --- LICENSE | 21 ++++++++++++ README.md | 100 +++++++++++++++++++++++++----------------------------- 2 files changed, 67 insertions(+), 54 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7c500f5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 E-VoteChain + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 40ede56..7f28044 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,46 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: - -```js -export default tseslint.config({ - extends: [ - // Remove ...tseslint.configs.recommended and replace with this - ...tseslint.configs.recommendedTypeChecked, - // Alternatively, use this for stricter rules - ...tseslint.configs.strictTypeChecked, - // Optionally, add this for stylistic rules - ...tseslint.configs.stylisticTypeChecked, - ], - languageOptions: { - // other options... - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - }, -}) -``` - -You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules: - -```js -// eslint.config.js -import reactX from 'eslint-plugin-react-x' -import reactDom from 'eslint-plugin-react-dom' - -export default tseslint.config({ - plugins: { - // Add the react-x and react-dom plugins - 'react-x': reactX, - 'react-dom': reactDom, - }, - rules: { - // other rules... - // Enable its recommended typescript rules - ...reactX.configs['recommended-typescript'].rules, - ...reactDom.configs.recommended.rules, - }, -}) -``` +# VoteChain - Decentralized Voting Application + +## Overview +VoteChain is a cutting-edge decentralized voting application designed to revolutionize the electoral process through the power of blockchain technology. It enhances trust, transparency, and security in elections by leveraging a robust architecture comprising React.js, Redux for state management, and Web3.js for seamless interaction with the Ethereum blockchain. + +## Key Features +- **Administrator Functions:** + - Admin Registration + - Election Management + - Candidate Selection + - Voter Authorization + +- **Voter Functions:** + - Voter Registration + - Election Participation + - Election Results Viewing + +## Technology Stack +- **Frontend:** + - React.tsx: Component-based architecture for a responsive user interface. + - Context API: State management library crucial for handling user authentication and voting data. + +- **Blockchain Interaction:** + - Ethers: Facilitates communication between the frontend and the Ethereum blockchain. + +- **Smart Contracts:** + - Solidity: Smart contracts deployed on the Ethereum blockchain to manage core functionalities. + +## System Architecture +VoteChain operates as a decentralized application with three main layers: +1. **Presentation Layer (Frontend):** + - React.js Interface + - Web3 Integration for Ethereum Blockchain Communication + +2. **Logic Layer (Backend):** + - Solidity Smart Contracts on Ethereum + - Server-Side APIs for Communication + +3. **Data Layer (Blockchain):** + - Sepholia Ethereum Blockchain for Immutable Data Storage + +## User-Centric Design +VoteChain prioritizes a user-friendly interface, stringent security measures, and role-based access control to ensure an authentic and seamless voting experience. + +## Scalability and Maintenance +The platform is designed for scalability, utilizing load balancing, elastic infrastructure, and efficient resource utilization. Scheduled upgrades, patch management, and a comprehensive support ecosystem ensure \ No newline at end of file