Skip to content

Commit 11e5f53

Browse files
committed
📝 docs: add badges
1 parent 591db54 commit 11e5f53

File tree

1 file changed

+18
-200
lines changed

1 file changed

+18
-200
lines changed

readme.md

Lines changed: 18 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
1-
21
# Snigdha OS Web 🌐
32

43
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. 🚀
54

6-
[![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys)
5+
<div align="center">
6+
<!-- Build Status Badge -->
7+
[![Netlify Status](https://api.netlify.com/api/v1/badges/03563b4f-142a-4d7d-8d97-ecfff7b87b29/deploy-status)](https://app.netlify.com/sites/snigdhaos/deploys)
8+
9+
<!-- License Badge -->
10+
![MIT License](https://img.shields.io/badge/license-MIT-green)
11+
12+
<!-- Dependencies Badge -->
13+
![Dependencies](https://img.shields.io/david/Snigdha-OS/snigdha-os.github.io)
14+
15+
<!-- Code Quality Badge -->
16+
![Code Quality](https://img.shields.io/codecov/c/github/Snigdha-OS/snigdha-os.github.io)
17+
18+
<!-- Test Coverage Badge -->
19+
![Test Coverage](https://img.shields.io/coveralls/github/Snigdha-OS/snigdha-os.github.io)
20+
21+
</div>
722

823
## Table of Contents 📑
924

@@ -101,202 +116,5 @@ These are various commands that help automate tasks in the development process:
101116

102117
## Repository Structure 📂
103118

104-
Here is the general structure of the repository:
105-
106-
```
107-
snigdha-os.github.io/
108-
.
109-
├── CODE_OF_CONDUCT.md
110-
├── config.sh
111-
├── CONTRIBUTING.md
112-
├── eslint.config.js
113-
├── index.html
114-
├── LICENSE
115-
├── package.json
116-
├── package-lock.json
117-
├── postcss.config.js
118-
├── public
119-
│ ├── 404.html
120-
│ ├── favicon.ico
121-
│ ├── favicon.svg
122-
│ ├── snigdhaos-logo.png
123-
│ └── snigdhaos-og.png
124-
├── push.sh
125-
├── readme.md
126-
├── src
127-
│ ├── App.tsx
128-
│ ├── components
129-
│ │ ├── about
130-
│ │ │ ├── MissionSection.tsx
131-
│ │ │ ├── TeamSection.tsx
132-
│ │ │ └── Timeline.tsx
133-
│ │ ├── developers
134-
│ │ │ ├── ContributorCard.tsx
135-
│ │ │ ├── ContributorStats.tsx
136-
│ │ │ ├── RepoCard.tsx
137-
│ │ │ └── TeamMemberCard.tsx
138-
│ │ ├── donate
139-
│ │ │ ├── DonationTier.tsx
140-
│ │ │ ├── DonorWall.tsx
141-
│ │ │ ├── GithubSponsorButton.tsx
142-
│ │ │ ├── KeySponsors.tsx
143-
│ │ │ ├── SponsorshipStats.tsx
144-
│ │ │ └── SponsorshipTiers.tsx
145-
│ │ ├── download
146-
│ │ │ ├── Checksum.tsx
147-
│ │ │ ├── DownloadButton.tsx
148-
│ │ │ ├── MirrorList.tsx
149-
│ │ │ ├── NetworkSpeed.tsx
150-
│ │ │ ├── SuggestedMirror.tsx
151-
│ │ │ └── SystemRequirements.tsx
152-
│ │ ├── features
153-
│ │ │ ├── CategoryFilter.tsx
154-
│ │ │ ├── SearchBar.tsx
155-
│ │ │ └── ToolCard.tsx
156-
│ │ ├── gallery
157-
│ │ │ ├── CategoryFilter.tsx
158-
│ │ │ └── GalleryImage.tsx
159-
│ │ ├── home
160-
│ │ │ ├── ComparisonSection.tsx
161-
│ │ │ ├── FeatureCard.tsx
162-
│ │ │ ├── HeroSection.tsx
163-
│ │ │ ├── StatsSection.tsx
164-
│ │ │ ├── TestimonialCard.tsx
165-
│ │ │ └── ToolsShowcase.tsx
166-
│ │ ├── layout
167-
│ │ │ ├── Footer
168-
│ │ │ │ ├── ContactSection.tsx
169-
│ │ │ │ └── index.tsx
170-
│ │ │ ├── Footer.tsx
171-
│ │ │ └── Navbar.tsx
172-
│ │ └── ui
173-
│ │ └── ErrorBoundary.tsx
174-
│ ├── data
175-
│ │ ├── donations.ts
176-
│ │ ├── download.ts
177-
│ │ ├── footerNavigation.ts
178-
│ │ ├── gallery.ts
179-
│ │ ├── mirrors
180-
│ │ │ ├── africa.ts
181-
│ │ │ ├── americas.ts
182-
│ │ │ ├── asia.ts
183-
│ │ │ ├── europe.ts
184-
│ │ │ ├── index.ts
185-
│ │ │ └── oceania.ts
186-
│ │ ├── mirrors.ts
187-
│ │ ├── navigation.ts
188-
│ │ ├── team.ts
189-
│ │ ├── testimonials.ts
190-
│ │ └── tools.ts
191-
│ ├── hooks
192-
│ │ ├── useLocation.ts
193-
│ │ └── useNetworkSpeed.ts
194-
│ ├── index.css
195-
│ ├── lib
196-
│ │ ├── currency.ts
197-
│ │ ├── github.ts
198-
│ │ ├── location.ts
199-
│ │ ├── network.ts
200-
│ │ └── utils.ts
201-
│ ├── main.tsx
202-
│ ├── pages
203-
│ │ ├── About.tsx
204-
│ │ ├── Developers.tsx
205-
│ │ ├── Donate.tsx
206-
│ │ ├── Download.tsx
207-
│ │ ├── Features.tsx
208-
│ │ ├── Gallery.tsx
209-
│ │ └── Home.tsx
210-
│ ├── routes.tsx
211-
│ ├── types
212-
│ │ └── download.ts
213-
│ └── vite-env.d.ts
214-
├── tailwind.config.js
215-
├── tsconfig.app.json
216-
├── tsconfig.json
217-
├── tsconfig.node.json
218-
└── vite.config.ts
219-
```
220-
221-
## Developers 👨‍💻👩‍💻
222-
223-
- **Eshanized** - Lead Developer, Web Architect 🔧
224-
- **RiO** - Developer & Maintainer
225-
226-
If you would like to contribute or join the team, feel free to reach out! 📬
227-
228-
## Development Guide 📚
229-
230-
### Prerequisites 📥
231-
232-
To get started with development, you need:
233-
234-
- **Node.js** and **pnpm** installed on your local machine.
235-
- A modern web browser (Chrome, Firefox, etc.) for testing and debugging.
236-
- A code editor (VSCode, Sublime Text, etc.).
237-
- Familiarity with React.js, JavaScript, CSS, and Git.
238-
239-
### Setting Up the Development Environment 🛠️
240-
241-
1. Clone the repository:
242-
```bash
243-
git clone https://github.com/Snigdha-OS/snigdha-os.github.io.git
244-
cd snigdha-os.github.io
245-
```
246-
247-
2. Install dependencies:
248-
```bash
249-
pnpm install
250-
```
251-
252-
3. Run the development server:
253-
```bash
254-
pnpm dev
255-
```
256-
257-
This will start the development server at `http://localhost:5173`. Any changes
258-
259-
made to the code will be reflected immediately. 🔄
260-
261-
### Contribution Guidelines ✍️
262-
263-
- **Fork the repository** and clone your fork locally.
264-
- Create a new branch for each feature or bug fix:
265-
```bash
266-
git checkout -b feature-name
267-
```
268-
- Make your changes, commit them with clear and descriptive commit messages.
269-
- Push your changes to your fork and create a pull request to the `main` branch.
270-
271-
### Code Style and Best Practices 💡
272-
273-
- Follow a consistent style guide for JavaScript and CSS.
274-
- Use meaningful variable names, and avoid long functions.
275-
- Comment complex logic to explain the reasoning behind it.
276-
- Use `pnpm run lint` to check for code style issues before committing.
277-
278-
### Testing 🧪
279-
280-
To test changes locally, run:
281-
```bash
282-
pnpm run test
283-
```
284-
285-
This will run the Jest test suite for any components or functions that have been set up for testing.
286-
287-
## Contributing 🤝
288-
289-
We welcome contributions from everyone! If you'd like to contribute to Snigdha OS Web, please follow these steps:
290-
291-
1. Fork the repository.
292-
2. Clone your fork locally and create a new branch.
293-
3. Make your changes and test them.
294-
4. Create a pull request with a clear description of your changes.
295-
296-
If you have any ideas or suggestions, please feel free to open an issue or start a discussion. 💬
297-
298-
## License 📜
299-
300-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
119+
The project is organized as follows:
301120

302-
<div align="center">Thanks for contributing to Snigdha OS Web! 🌟</div>

0 commit comments

Comments
 (0)