Skip to content

Commit

Permalink
βͺ revert: head^1
Browse files Browse the repository at this point in the history
  • Loading branch information
eshanized committed Jan 13, 2025
1 parent 11e5f53 commit ffab675
Showing 1 changed file with 200 additions and 18 deletions.
218 changes: 200 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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">
<!-- 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>
[![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys)

## Table of Contents πŸ“‘

Expand Down Expand Up @@ -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>

0 comments on commit ffab675

Please sign in to comment.