chore: create repo

OPCODE-Open-Spring-Fest · Mar 20, 2024 · 3547c5f · 3547c5f
1 parent 4bc23cc
commit 3547c5f
Show file tree

Hide file tree

Showing 71 changed files with 33,806 additions and 13 deletions.
diff --git a/.github/Contributor_Guide/Project_Tour.md b/.github/Contributor_Guide/Project_Tour.md
@@ -1,12 +1,184 @@
 # Project Tour
-
+## Level Medium
 * notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
-
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+*  ># Documentation
+*  > This directory structure represents a project with both frontend and backend components.
+
+*  >In the root directory, there are configuration files like .gitignore, CODE_OF_CONDUCT.md, and package.json. The .github directory contains files related to GitHub workflows, issue templates, and pull request templates. The .husky directory contains pre-commit and commit-msg hooks.
+* >The "client" directory contains the frontend codebase with subdirectories for public assets and source files. The "src" directory within "client" contains components, Axios API configuration, and other frontend-related files.
+
+* >The "server" directory contains the backend codebase, including an Auth module, database models, and an entry point (index.js) for the server.
+
+* >Overall, the project seems to be a web application with a React-based frontend (client) and a Node.js-based backend (server), possibly utilizing MongoDB for data storage.
+## Frontend
+
+The "client" folder contains all the frontend-related code for the project. Here's a breakdown of its contents:
+
+1. **package-lock.json** and **package.json**: These files manage the dependencies and scripts required for the frontend.
+
+2. **README.md**: This file typically contains documentation or instructions specific to the frontend part of the project.
+
+3. **tailwind.config.js**: This file is likely used to configure Tailwind CSS, a utility-first CSS framework, for customizing the project's styles.
+
+4. **public**: This directory holds static assets like images and HTML files. It typically contains files like favicons, index.html, and robots.txt.
+
+5. **src**: This directory contains the actual source code for the frontend. Here's a breakdown of its contents:
+
+   - **App.css** and **index.css**: These are CSS files used to style the main app component and index file, respectively.
+   - **App.jsx**: This is the main component of the React application, where other components are typically imported and rendered.
+   - **index.js**: This file serves as the entry point for the React application, where the main App component is rendered into the DOM.
+
+   Additionally, the "src" directory contains subdirectories for organizing different aspects of the frontend:
+
+   - **Assets**: This directory likely holds various assets used in the application, such as images and logos.
+   - **axios**: This directory may contain configuration files or utility functions related to Axios, a promise-based HTTP client for making requests.
+   - **components**: This directory contains reusable UI components used throughout the application. Each component typically has its own directory, which may include CSS files and other related assets.
+
+     - Within the "components" directory, there are subdirectories for organizing different types of components, such as "Body" and "Form".
+
+   - **lotties**: This directory may contain JSON files used with Lottie, a library for rendering After Effects animations in real-time.
+
+   - **pages**: This directory contains React components that represent individual pages/routes of the application. Each component corresponds to a specific URL route and may contain JSX code for rendering the page's content.
+
+* Overall, the "client" folder structure is organized to facilitate the development of a React-based frontend application, with separate directories for static assets, source code, and various components.
+## Backend
+The "server" folder contains all the backend-related code for the project. Here's a breakdown of its contents:
+
+1. **.env**: This file typically stores environment variables, such as API keys or database connection strings, used by the backend application.
+
+2. **Auth.js**: This file likely contains authentication-related logic, such as middleware functions or routes for user authentication and authorization.
+
+3. **index.js**: This file serves as the entry point for the backend application. It may set up the server, define routes, and connect to the database.
+
+4. **package-lock.json** and **package.json**: These files manage the dependencies and scripts required for the backend.
+
+5. **models**: This directory likely contains database models, which define the structure and behavior of data stored in the database. Here's a breakdown of its contents:
+
+   - **lsp.js** and **user.js**: These files likely define MongoDB models for storing data related to legal service providers (LSPs) and users, respectively.
+
+* Overall, the "server" folder structure is organized to facilitate the development of a Node.js-based backend application, with separate files for defining routes, handling authentication, connecting to the database, and defining database models.
+# Folder structure
+```js
+|   .gitignore
+|   CODE_OF_CONDUCT.md
+|   commitlint.config.js
+|   package-lock.json
+|   package.json
+|   README.md
+|
++---.github
+|   +---Contributor_Guide
+|   |       commiting.md
+|   |       Contributing.md
+|   |       Project_Tour.md
+|   |
+|   +---ISSUE_TEMPLATE
+|   |       bug_report.yaml
+|   |       feature_request.yaml
+|   |
+|   +---PULL_REQUEST_TEMPLATE
+|   |       pr.md
+|   |
+|   \---workflows
+|           commitlint.yaml
+|           prmerged.yaml
+|
++---.husky
+|       commit-msg
+|       pre-commit
+|
++---client
+|   |   package-lock.json
+|   |   package.json
+|   |   README.md
+|   |   tailwind.config.js
+|   |
+|   +---public
+|   |       favicon-16x16.png
+|   |       favicon-32x32.png
+|   |       favicon.ico
+|   |       index.html
+|   |       robots.txt
+|   |
+|   \---src
+|       |   App.css
+|       |   App.jsx
+|       |   index.css
+|       |   index.js
+|       |
+|       +---Assets
+|       |       bimlesh.jpg
+|       |       chatImg.png
+|       |       ellipse-3.png
+|       |       hammer.png
+|       |       image.png
+|       |       jagpreetjpg.jpg
+|       |       linkedin.png
+|       |       logo2.jpg
+|       |       nilesh.jpg
+|       |       Sample_logo.png
+|       |       shaikh.jpg
+|       |       somya.jpg
+|       |       sonu.jpg
+|       |
+|       +---axios
+|       |       api.js
+|       |
+|       +---components
+|       |   |   Chat.jsx
+|       |   |   Footer.css
+|       |   |   Footer.jsx
+|       |   |   Header.css
+|       |   |   Header.jsx
+|       |   |   LegalMarketplace.jsx
+|       |   |   legal_marketplace.css
+|       |   |   MyInteractions.jsx
+|       |   |   my_interactions.css
+|       |   |   preloader.css
+|       |   |   preloader.jsx
+|       |   |   PresonalChat.jsx
+|       |   |   PresonalLB.jsx
+|       |   |   SignIn.jsx
+|       |   |   SignUp.jsx
+|       |   |   signUpIn.css
+|       |   |   SignUpLSP.jsx
+|       |   |   SignUpUser.jsx
+|       |   |   testimonial.css
+|       |   |   testimonial.jsx
+|       |   |
+|       |   +---Body
+|       |   |   |   body.css
+|       |   |   |   Body.jsx
+|       |   |   |
+|       |   |   \---Mid
+|       |   |           FAQ.jsx
+|       |   |           mid.css
+|       |   |           Mid.jsx
+|       |   |
+|       |   \---Form
+|       |           form.css
+|       |           Form.jsx
+|       |
+|       +---lotties
+|       |       law.json
+|       |
+|       \---pages
+|               Article.jsx
+|               Dashboard.css
+|               Dashboard.jsx
+|               Error.jsx
+|               Home.jsx
+|               Setting.jsx
+|               Sidebar.jsx
+|
+\---server
+    |   .env
+    |   Auth.js
+    |   index.js
+    |   package-lock.json
+    |   package.json
+    |
+    \---models
+            lsp.js
+            user.js
+```
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-node_modules
+node_modules
+.env
diff --git a/README.md b/README.md
@@ -1,2 +1,91 @@
-# template
-A Template Repository for OpenSpringFest (OSF)
+# NyaySeva
+
+## Overview
+
+Welcome to NyaySeva, the groundbreaking web application that is revolutionizing access to legal services in India. This project has been developed for the Smart India Hackathon, a platform dedicated to innovative solutions for pressing challenges in India. NyaySeva addresses the specific problem statement outlined below.
+
+### Problem Statement
+
+#### Problem Statement 1286:
+
+Incentives based Design for onboarding Legal Service Providers such as Advocates, Arbitrators, Mediators, Notaries, Document Writers, etc. on an e-Marketplace for extending Legal Services to Citizens in India.
+
+#### Problem Statement Description:
+
+In India, there exists a diverse array of legal service providers, including Advocates, Arbitrators, Mediators, Notaries, Document Writers, and more, who play pivotal roles in ensuring justice and legal compliance. However, the process of onboarding these essential legal service providers onto a unified platform has been traditionally cumbersome and inefficient. This disconnect often leaves citizens without easy access to the legal expertise they require.
+
+## Table of Contents
+
+1. [Getting Started](#getting-started)
+   - [Prerequisites](#prerequisites)
+   - [Installation](#installation)
+2. [Features](#features)
+   - [Incentive Mechanisms](#incentive-mechanisms)
+   - [User-Friendly Interface](#user-friendly-interface)
+   - [Verification and Trust](#verification-and-trust)
+   - [Comprehensive Services](#comprehensive-services)
+   - [Feedback and Ratings](#feedback-and-ratings)
+3. [Our Team](#our-Team)
+
+4. [Usage](#usage)
+   - [User Registration](#user-registration)
+   - [Browsing Legal Professionals](#browsing-legal-professionals)
+   - [Connecting with Legal Professionals](#connecting-with-legal-professionals)
+5. [Acknowledgement](#acknowledgement)
+
+## Getting Started
+
+
+### Prerequisites
+
+Before you begin, ensure you have the following prerequisites:
+
+- A modern web browser
+- Internet access
+
+### Installation
+
+NyaySeva is a web-based platform, so there's no need for installation. Simply open your web browser and visit our website at [www.nyayseva.com](https://www.nyayseva.com).
+
+## Features
+
+### Incentive Mechanisms
+
+NyaySeva employs innovative incentives such as performance-based rewards, visibility boosters, and collaborative opportunities to encourage legal service providers to join the platform.
+
+### User-Friendly Interface
+
+Our user-centric design ensures that citizens can easily browse, search, and connect with the right legal professionals, making access to legal services more convenient than ever.
+
+### Verification and Trust
+
+NyaySeva incorporates rigorous verification processes to ensure the legitimacy of listed legal professionals, fostering trust and credibility within the platform.
+
+### Comprehensive Services
+
+From legal consultations to document drafting and mediation, NyaySeva encompasses a wide array of legal services to cater to the diverse needs of Indian citizens.
+
+### Feedback and Ratings
+
+Transparent feedback and rating systems empower users to make informed choices when selecting legal service providers, promoting accountability and quality service delivery.
+
+##Tech stack 
+### React javascript tailwind node express mongoDB mongoose 
+
+## Usage
+
+### Registration
+
+To access NyaySeva's services, users are required to register an account. Registration is simple and straightforward, and it allows you to personalize your experience on the platform, while legal service providers are required to create a proper profile for client and also provide supporting document for verification process.
+
+### Browsing Legal Professionals
+
+Once registered, users can browse and search for legal professionals based on their specific requirements. Our intuitive search interface makes it easy to find the right legal expert.
+
+### Connecting with Legal Professionals
+
+NyaySeva facilitates easy and secure connections with legal professionals. Users can request consultations, document drafting, or mediation services, and legal professionals can respond promptly.
+
+## Acknowledgement
+
+Thank you for choosing NyaySeva! We're excited to have you on board, whether you're a legal service provider looking to extend your services or a user seeking accessible legal expertise. NyaySeva is here to make legal services more accessible and efficient for everyone as part of the Smart India Hackathon.
diff --git a/client/README.md b/client/README.md
@@ -0,0 +1 @@
+# SIH Project, Private Repo