https://github.com/charmingdc/swiftscan
SwiftScan is a minimalistic and open-source QR code generator created with Typescript.
https://github.com/charmingdc/swiftscan
Last synced: over 1 year ago
JSON representation
SwiftScan is a minimalistic and open-source QR code generator created with Typescript.
- Host: GitHub
- URL: https://github.com/charmingdc/swiftscan
- Owner: Charmingdc
- License: mit
- Created: 2024-12-09T21:38:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T01:21:21.000Z (over 1 year ago)
- Last Synced: 2025-02-15T01:25:24.549Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://swiftscan-delta.vercel.app/
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftScan ⚡
**SwiftScan** is a minimalistic and open-source QR code generator. Create QR codes effortlessly for email addresses, phone numbers, text, or URLs. SwiftScan is designed to be simple, fast, and accessible to everyone. 🚀
---
## Features 🔍
- **Generate QR Codes for Various Data Types:**
- Email Addresses
- Phone Numbers
- Plain Text
- URLs
- **Open Source:** Built for the community to use, learn from, and improve.
- **Lightweight & Fast:** No frameworks, only Typescript with the [Notyf](https://github.com/caroso1222/notyf) library for alerts.
- **Cross-Platform:** Works seamlessly on web browsers and mobile devices.
---
## Installation ✨
Clone the repository or download it directly:
```bash
git clone https://github.com/Charmingdc/swiftscan.git
```
Open the `index.html` file in your browser, and you're ready to go!
---
## Usage 🚀
### 1. Clone the Repository
```bash
git clone https://github.com/Charmingdc/swiftscan.git
```
### 2. Open `index.html`
Simply open the `index.html` file in your browser to start using SwiftScan.
### 3. Input Options
- **Email:** Enter an email address (e.g., `example@gmail.com`).
- **Phone Number:** Provide a phone number in international format.
- **Text:** Add any text you wish to encode.
- **URL:** Insert a valid web URL (e.g., `https://example.com`).
Once the input is provided, a QR code will be generated instantly, and a success alert will be displayed using Notyf.
---
## Development ⚒️
Want to contribute? Follow these steps:
1. Fork the repository.
2. Create your feature branch:
```bash
git checkout -b feature/amazing-feature
```
3. Commit your changes:
```bash
git commit -m 'Add some amazing feature'
```
4. Push to the branch:
```bash
git push origin feature/amazing-feature
```
5. Open a pull request.
---
## License 📑
SwiftScan is open-source software licensed under the [MIT License](./LICENSE).
---
## Contributing 👥
Contributions are always welcome! Whether it's fixing bugs, improving documentation, or building new features, we appreciate your help.
---
## Contact ☎️
For issues, feature requests, or discussions, feel free to create an issue in the GitHub repository.
---
**Start generating QR codes quickly and easily with SwiftScan!**