https://github.com/hotaydev/professional-contact-app
Professional Contact app that transfers the contact via QR Code and simple vCard
https://github.com/hotaydev/professional-contact-app
Last synced: 11 months ago
JSON representation
Professional Contact app that transfers the contact via QR Code and simple vCard
- Host: GitHub
- URL: https://github.com/hotaydev/professional-contact-app
- Owner: hotaydev
- License: agpl-3.0
- Created: 2024-10-15T01:09:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-25T12:31:31.000Z (over 1 year ago)
- Last Synced: 2024-11-25T13:30:23.339Z (over 1 year ago)
- Language: Dart
- Homepage:
- Size: 1.91 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Professional Contact App
A lightweight, fast, and privacy-focused app for sharing your professional contact details via QR Code or by sending it to other applications. Ideal for entrepreneurs or small business owners who need a hassle-free way to share their contact information. No ads, no trackers, and free forever!
---
## Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Why This App?](#why-this-app)
4. [Tech Stack](#tech-stack)
5. [Contributing](#contributing)
6. [License](#license)
7. [Developing the App](#developing-the-app)
---
## Introduction
Inspired by physical business cards like [Taggo](https://taggo.one/) and [Monocard](https://monocard.com.br/), this app provides a modern, digital alternative that eliminates the need for carrying a card. Perfect for small businesses or startups, this app is **free**, **lightweight**, and **convenient**, helping you share your professional details instantly with QR codes.
## Features
- **Share your professional contact** easily:
- Via QR Code (for all devices)
- As a Virtual Contact Card (vCard)
- **Privacy first**: No ads or trackers.
- **Light and fast**: Under 10 MB.
- **Disable error reporting** for enhanced privacy (enabled by default).
- **Open-source**: Free forever under AGPL-3.0.
- **Supports multiple languages**.
- Available for **Android** (iOS coming soon).
## Why This App?
Other contact-sharing solutions, like physical cards, can be expensive and less practical. With this app, you can:
- Share your contact details instantly without carrying an additional card.
- Ensure privacy and control over your data.
- Enjoy a completely **ad-free** experience.
- Use it free of cost—now and forever, backed by an open-source license.
---
## Tech Stack
This is a [Flutter](https://flutter.dev/) app, utilizing the following open-source packages:
- **[device_info_plus](https://pub.dev/packages/device_info_plus)**
- **[easy_localization](https://pub.dev/packages/easy_localization)**
- **[http](https://pub.dev/packages/http)**
- **[package_info_plus](https://pub.dev/packages/package_info_plus)**
- **[path_provider](https://pub.dev/packages/path_provider)**
- **[provider](https://pub.dev/packages/provider)**
- **[qr_flutter](https://pub.dev/packages/qr_flutter)**
- **[share_plus](https://pub.dev/packages/share_plus)**
- **[shared_preferences](https://pub.dev/packages/shared_preferences)**
- **[url_launcher](https://pub.dev/packages/url_launcher)**
- **[cached_network_image](https://pub.dev/packages/cached_network_image)**
---
## Contributing
We welcome contributors! Whether it's adding translations, fixing bugs, or developing new features, your help is invaluable.
### How to Contribute:
1. Start by creating an Issue to discuss your ideas or problems.
2. After discussions, feel free to submit a Pull Request.
3. Before contributing, you’ll need to sign a Contributor License Agreement (CLA)—handled by a bot in this repo.
**Ways to contribute:**
- Translation
- Bug fixes
- Feature development
---
## License
This app is licensed under the [AGPL-3.0 License](./LICENSE). This ensures that any forks of the app **must** remain open-source and clearly show what changes have been made. Commercial use is allowed, but the source code must always be accessible.
We chose this license to guarantee that the app remains free and open-source forever. If you wish to contribute, please note that your contributions may be used commercially to support the financial sustainability of the project, but the app itself will always remain free.
---
## Developing the App
### Prerequisites
If you're using **Windows**, it's recommended to run the following commands in either [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or [DevContainers](https://containers.dev/).
### Setup and Run
1. **Run** `make setup`:
- This will guide you through code signing setup (it might open a browser link with instructions from Flutter).
2. **Run** the app on a device:
- `flutter run -d --dart-define-from-file=variables.json` (you can list devices with `flutter devices`). If the `--dart-define-from-file` flag is omitted, default values will be used.
#### VSCode Users
A pre-configured `.vscode/launch.json` file is provided, enabling easy setup with the Flutter/Dart VSCode extension.
### Makefile Commands
You can use the following commands from the `Makefile`:
- `make apk` – Build APK.
- `make appbundle` – Build Android AppBundle.
- `make analyze` – Analyze Android ARM64 version size structure.
- `make run` – Run the app on the default device using `--dart-define-from-file`.
- `make clean` – Clean pub caches.
- `make upgrade` – Upgrade pub dependencies.
- `make outdated` – Check for outdated packages.
- `make get` – Get pub packages.
- `make icons` – Generate app icons from `assets/icon/icon.png`.
- `make get_native_symbols` – Get native symbols for publishing on Play Store.
---
## Join Us in Building a Better App
We're excited to have you contribute to this project. Whether you're helping with translations, fixing bugs, or adding features, your input is highly valued. Before submitting a pull request, please create an issue to discuss your ideas.