mirror of
https://github.com/Snigdha-OS/package-browser.git
synced 2025-09-20 11:35:01 +02:00
106 lines
4.1 KiB
Markdown
106 lines
4.1 KiB
Markdown
# 📦 Package Browser - Search Packages
|
||
|
||
<p align="center">
|
||
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" alt="License: MIT"></a>
|
||
<a href="https://github.com/Snigdha-OS/package-browser/releases"><img src="https://img.shields.io/github/package-json/v/Snigdha-OS/package-browser?style=for-the-badge" alt="Version"></a>
|
||
<a href="https://github.com/Snigdha-OS/package-browser/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=for-the-badge" alt="Contributions Welcome"></a>
|
||
<!-- <a href="https://github.com/Snigdha-OS/package-browser/actions"><img src="https://img.shields.io/github/actions/workflow/status/Snigdha-OS/package-browser/ci.yml?branch=main&style=for-the-badge" alt="Build Status"></a> -->
|
||
<a href="https://snigdha-os.github.io"><img src="https://img.shields.io/website?url=https%3A%2F%2Fsnigdha-os.github.io&style=for-the-badge" alt="Website Status"></a>
|
||
</p>
|
||
|
||
🚀 **Package Browser** is a user-friendly web application designed to simplify browsing, searching, and exploring packages available for Snigdha OS. This tool helps users find the right software with ease, whether for development, daily use, or penetration testing.
|
||
|
||
## 🌟 Features
|
||
|
||
- 🔍 **Search and Filter**: Quickly search and filter through a comprehensive list of packages.
|
||
- 📜 **Detailed Package Info**: View package descriptions, versions, dependencies, and more.
|
||
- ⚡ **Fast and Intuitive**: Built with performance and usability in mind.
|
||
- 🎨 **Customizable Interface**: Light and dark themes to match your preferences.
|
||
|
||
## 🗂️ Repository Structure
|
||
|
||
```plaintext
|
||
package-browser/
|
||
.
|
||
├── CODE_OF_CONDUCT.md
|
||
├── config.sh
|
||
├── eslint.config.js
|
||
├── index.html
|
||
├── package.json
|
||
├── pnpm-lock.yaml
|
||
├── postcss.config.js
|
||
├── public
|
||
│ ├── favicon.ico
|
||
│ └── snigdhaos-og-image.png
|
||
├── push.sh
|
||
├── README.md
|
||
├── src
|
||
│ ├── App.tsx
|
||
│ ├── components
|
||
│ │ ├── Header.tsx
|
||
│ │ ├── InstallGuide.tsx
|
||
│ │ ├── Logo.tsx
|
||
│ │ ├── PackageCard.tsx
|
||
│ │ ├── PackageList.tsx
|
||
│ │ ├── SearchBar.tsx
|
||
│ │ └── ThemeToggle.tsx
|
||
│ ├── hooks
|
||
│ │ ├── usePackages.ts
|
||
│ │ └── useTheme.ts
|
||
│ ├── i18n.tsx
|
||
│ ├── index.css
|
||
│ ├── locales
|
||
│ │ ├── en.tsx
|
||
│ │ └── uk.tsx
|
||
│ ├── main.tsx
|
||
│ ├── services
|
||
│ │ └── api.ts
|
||
│ ├── types.ts
|
||
│ └── vite-env.d.ts
|
||
├── tailwind.config.js
|
||
├── tsconfig.app.json
|
||
├── tsconfig.json
|
||
├── tsconfig.node.json
|
||
└── vite.config.ts
|
||
```
|
||
|
||
## 🛠️ Installation
|
||
|
||
Clone the repository and set up the project:
|
||
```bash
|
||
git clone https://github.com/Snigdha-OS/package-browser.git
|
||
cd package-browser
|
||
pnpm install
|
||
pnpm run dev
|
||
```
|
||
|
||
## 🌐 Usage
|
||
|
||
1. Launch the app locally by running `pnpm run dev`.
|
||
2. Open your browser and navigate to `http://localhost:5173/package-browser/`.
|
||
3. Search for packages, view details, and explore dependencies.
|
||
|
||
## 🤝 Contributing
|
||
|
||
We welcome contributions from the community! Here’s how you can help:
|
||
|
||
1. 🍴 Fork the repository.
|
||
2. 🛠️ Create a feature branch: `git checkout -b feature-name`.
|
||
3. 🐛 Fix issues or add new features.
|
||
4. 📝 Commit changes: `git commit -m "Add feature/bug fix description"`.
|
||
5. 🔄 Push changes and create a pull request.
|
||
|
||
## 👤 Author
|
||
|
||
This project is developed and maintained by the **Snigdha OS Team** under the guidance of **Tonmoy Infrastructure**.
|
||
|
||
- 💻 GitHub: [Snigdha OS](https://github.com/Snigdha-OS)
|
||
- 🌐 Website: [Snigdha OS](https://snigdha-os.github.io)
|
||
|
||
## 📃 License
|
||
|
||
This project is licensed under the [MIT License](LICENSE).
|
||
|
||
## 💬 Feedback
|
||
|
||
We’d love to hear your feedback and suggestions! Feel free to open an issue or contact us directly via the [Snigdha OS](https://github.com/Snigdha-OS) organization. |