Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gtg922r/zip-extractor
https://github.com/gtg922r/zip-extractor
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gtg922r/zip-extractor
- Owner: gtg922r
- Created: 2024-12-01T17:17:03.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2024-12-02T14:43:29.000Z (21 days ago)
- Last Synced: 2024-12-02T14:47:21.891Z (21 days ago)
- Language: TypeScript
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ZIP Extractor
## About The Project
ZIP Extractor is a modern web application that allows users to extract and preview ZIP file contents directly in their browser. Built with Astro and React, it provides a seamless, fast, and secure way to handle ZIP files without requiring any server-side processing. ZIP Extractor works for any zip-compressed file, regardless of file type.
### Key Features
- 🚀 **Client-side Processing** - All file processing happens in your browser
- 🔍 **File Preview** - Preview images and JSON files before extraction
- 🌙 **Dark Mode** - Elegant dark mode support for comfortable viewing
- 📁 **Prefix Support** - Add custom prefixes to extracted files
- 💻 **Cross-Platform** - Works on any modern browser
- 🛡️ **Secure** - No file uploads, everything stays on your device
## Getting Started
### Prerequisites
- Node.js (version 16 or higher)
- npm
### Installation
1. Clone the repository
```sh
git clone https://github.com/gtg922r/zip-extractor.git
```
2. Navigate to the project directory
```sh
cd zip-extractor/zip-extractor-astro
```
3. Install dependencies
```sh
npm install
```
4. Start the development server
```sh
npm run dev
```
### Building for Production
```sh
npm run build
```
To preview the production build:
```sh
npm run preview
```
## Technology Stack
- [Astro](https://astro.build/) - Web Framework
- [React](https://reactjs.org/) - UI Components
- [Tailwind CSS](https://tailwindcss.com/) - Styling
- [shadcn/ui](https://ui.shadcn.com/) - UI Components
- [JSZip](https://stuk.github.io/jszip/) - ZIP File Processing
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Project Link: [https://github.com/gtg922r/zip-extractor](https://github.com/gtg922r/zip-extractor)
