⏪ revert: head^1

readme.md

@@ -1,24 +1,9 @@
+
 # Snigdha OS Web 🌐
 
 Welcome to the Snigdha OS Web repository! This repository contains the source code, components, and resources used for building and maintaining the official website for Snigdha OS. 🚀
 
-<div align="center">
+[![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys)
-  <!-- Build Status Badge -->
-  [![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys)
-  
-  <!-- License Badge -->
-  ![MIT License](https://img.shields.io/badge/license-MIT-green)
-  
-  <!-- Dependencies Badge -->
-  ![Dependencies](https://img.shields.io/david/Snigdha-OS/snigdha-os.github.io)
-  
-  <!-- Code Quality Badge -->
-  ![Code Quality](https://img.shields.io/codecov/c/github/Snigdha-OS/snigdha-os.github.io)
-  
-  <!-- Test Coverage Badge -->
-  ![Test Coverage](https://img.shields.io/coveralls/github/Snigdha-OS/snigdha-os.github.io)
-
-</div>
 
 ## Table of Contents 📑
 
@@ -116,5 +101,202 @@ These are various commands that help automate tasks in the development process:
 
 ## Repository Structure 📂
 
-The project is organized as follows:
+Here is the general structure of the repository:
 
+```
+snigdha-os.github.io/
+.
+├── CODE_OF_CONDUCT.md
+├── config.sh
+├── CONTRIBUTING.md
+├── eslint.config.js
+├── index.html
+├── LICENSE
+├── package.json
+├── package-lock.json
+├── postcss.config.js
+├── public
+│   ├── 404.html
+│   ├── favicon.ico
+│   ├── favicon.svg
+│   ├── snigdhaos-logo.png
+│   └── snigdhaos-og.png
+├── push.sh
+├── readme.md
+├── src
+│   ├── App.tsx
+│   ├── components
+│   │   ├── about
+│   │   │   ├── MissionSection.tsx
+│   │   │   ├── TeamSection.tsx
+│   │   │   └── Timeline.tsx
+│   │   ├── developers
+│   │   │   ├── ContributorCard.tsx
+│   │   │   ├── ContributorStats.tsx
+│   │   │   ├── RepoCard.tsx
+│   │   │   └── TeamMemberCard.tsx
+│   │   ├── donate
+│   │   │   ├── DonationTier.tsx
+│   │   │   ├── DonorWall.tsx
+│   │   │   ├── GithubSponsorButton.tsx
+│   │   │   ├── KeySponsors.tsx
+│   │   │   ├── SponsorshipStats.tsx
+│   │   │   └── SponsorshipTiers.tsx
+│   │   ├── download
+│   │   │   ├── Checksum.tsx
+│   │   │   ├── DownloadButton.tsx
+│   │   │   ├── MirrorList.tsx
+│   │   │   ├── NetworkSpeed.tsx
+│   │   │   ├── SuggestedMirror.tsx
+│   │   │   └── SystemRequirements.tsx
+│   │   ├── features
+│   │   │   ├── CategoryFilter.tsx
+│   │   │   ├── SearchBar.tsx
+│   │   │   └── ToolCard.tsx
+│   │   ├── gallery
+│   │   │   ├── CategoryFilter.tsx
+│   │   │   └── GalleryImage.tsx
+│   │   ├── home
+│   │   │   ├── ComparisonSection.tsx
+│   │   │   ├── FeatureCard.tsx
+│   │   │   ├── HeroSection.tsx
+│   │   │   ├── StatsSection.tsx
+│   │   │   ├── TestimonialCard.tsx
+│   │   │   └── ToolsShowcase.tsx
+│   │   ├── layout
+│   │   │   ├── Footer
+│   │   │   │   ├── ContactSection.tsx
+│   │   │   │   └── index.tsx
+│   │   │   ├── Footer.tsx
+│   │   │   └── Navbar.tsx
+│   │   └── ui
+│   │       └── ErrorBoundary.tsx
+│   ├── data
+│   │   ├── donations.ts
+│   │   ├── download.ts
+│   │   ├── footerNavigation.ts
+│   │   ├── gallery.ts
+│   │   ├── mirrors
+│   │   │   ├── africa.ts
+│   │   │   ├── americas.ts
+│   │   │   ├── asia.ts
+│   │   │   ├── europe.ts
+│   │   │   ├── index.ts
+│   │   │   └── oceania.ts
+│   │   ├── mirrors.ts
+│   │   ├── navigation.ts
+│   │   ├── team.ts
+│   │   ├── testimonials.ts
+│   │   └── tools.ts
+│   ├── hooks
+│   │   ├── useLocation.ts
+│   │   └── useNetworkSpeed.ts
+│   ├── index.css
+│   ├── lib
+│   │   ├── currency.ts
+│   │   ├── github.ts
+│   │   ├── location.ts
+│   │   ├── network.ts
+│   │   └── utils.ts
+│   ├── main.tsx
+│   ├── pages
+│   │   ├── About.tsx
+│   │   ├── Developers.tsx
+│   │   ├── Donate.tsx
+│   │   ├── Download.tsx
+│   │   ├── Features.tsx
+│   │   ├── Gallery.tsx
+│   │   └── Home.tsx
+│   ├── routes.tsx
+│   ├── types
+│   │   └── download.ts
+│   └── vite-env.d.ts
+├── tailwind.config.js
+├── tsconfig.app.json
+├── tsconfig.json
+├── tsconfig.node.json
+└── vite.config.ts
+```
+
+## Developers 👨‍💻👩‍💻
+
+- **Eshanized** - Lead Developer, Web Architect 🔧
+- **RiO** - Developer & Maintainer
+
+If you would like to contribute or join the team, feel free to reach out! 📬
+
+## Development Guide 📚
+
+### Prerequisites 📥
+
+To get started with development, you need:
+
+- **Node.js** and **pnpm** installed on your local machine.
+- A modern web browser (Chrome, Firefox, etc.) for testing and debugging.
+- A code editor (VSCode, Sublime Text, etc.).
+- Familiarity with React.js, JavaScript, CSS, and Git.
+
+### Setting Up the Development Environment 🛠️
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Snigdha-OS/snigdha-os.github.io.git
+   cd snigdha-os.github.io
+   ```
+
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+3. Run the development server:
+   ```bash
+   pnpm dev
+   ```
+
+   This will start the development server at `http://localhost:5173`. Any changes
+
+ made to the code will be reflected immediately. 🔄
+
+### Contribution Guidelines ✍️
+
+- **Fork the repository** and clone your fork locally.
+- Create a new branch for each feature or bug fix:
+  ```bash
+  git checkout -b feature-name
+  ```
+- Make your changes, commit them with clear and descriptive commit messages.
+- Push your changes to your fork and create a pull request to the `main` branch.
+
+### Code Style and Best Practices 💡
+
+- Follow a consistent style guide for JavaScript and CSS.
+- Use meaningful variable names, and avoid long functions.
+- Comment complex logic to explain the reasoning behind it.
+- Use `pnpm run lint` to check for code style issues before committing.
+
+### Testing 🧪
+
+To test changes locally, run:
+```bash
+pnpm run test
+```
+
+This will run the Jest test suite for any components or functions that have been set up for testing.
+
+## Contributing 🤝
+
+We welcome contributions from everyone! If you'd like to contribute to Snigdha OS Web, please follow these steps:
+
+1. Fork the repository.
+2. Clone your fork locally and create a new branch.
+3. Make your changes and test them.
+4. Create a pull request with a clear description of your changes.
+
+If you have any ideas or suggestions, please feel free to open an issue or start a discussion. 💬
+
+## License 📜
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+<div align="center">Thanks for contributing to Snigdha OS Web! 🌟</div>