diff --git a/readme.md b/readme.md index 618fdd2f..8f625db6 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,24 @@ - # 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. ๐Ÿš€ -[![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys) +
+ + [![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys) + + + ![MIT License](https://img.shields.io/badge/license-MIT-green) + + + ![Dependencies](https://img.shields.io/david/Snigdha-OS/snigdha-os.github.io) + + + ![Code Quality](https://img.shields.io/codecov/c/github/Snigdha-OS/snigdha-os.github.io) + + + ![Test Coverage](https://img.shields.io/coveralls/github/Snigdha-OS/snigdha-os.github.io) + +
## Table of Contents ๐Ÿ“‘ @@ -101,202 +116,5 @@ These are various commands that help automate tasks in the development process: ## Repository Structure ๐Ÿ“‚ -Here is the general structure of the repository: +The project is organized as follows: -``` -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. - -
Thanks for contributing to Snigdha OS Web! ๐ŸŒŸ