Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rclement/business-card-generator
Generate digital QR-code business cards
https://github.com/rclement/business-card-generator
business-card-generator flask hcard mecard python qrcode segno vcard
Last synced: about 2 months ago
JSON representation
Generate digital QR-code business cards
- Host: GitHub
- URL: https://github.com/rclement/business-card-generator
- Owner: rclement
- License: agpl-3.0
- Created: 2022-03-02T22:40:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T01:59:54.000Z (3 months ago)
- Last Synced: 2024-10-12T04:46:30.407Z (2 months ago)
- Topics: business-card-generator, flask, hcard, mecard, python, qrcode, segno, vcard
- Language: Python
- Homepage: https://business-card-generator.vercel.app
- Size: 480 KB
- Stars: 37
- Watchers: 3
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Business Card Generator
[](https://github.com/rclement/business-card-generator/actions/workflows/ci-cd.yml)
[](https://codecov.io/gh/rclement/business-card-generator)
[](https://github.com/rmnclmnt/business-card-generator/blob/master/LICENSE)
Everyone needs a business card. Or multiple ones. Or in multiple formats.
Might as well be able to generate them on the fly.
This software allows to generate digital QR-code business cards:
- [MeCard](https://en.wikipedia.org/wiki/MeCard_(QR_code))
- [vCard](https://en.wikipedia.org/wiki/VCard)
## Usage
The easiest way to generate a business card is to use the online
[web application](https://business-card-generator.vercel.app).
You can also integrate URLs for website/keynotes integration using the following scheme:
```
https://business-card-generator.vercel.app/.?
```
Available card types:
- `vcard`
- `mecard`
Available card formats:
- `svg`
- `png`
- `vcf`
Available card parameters:
| Parameter | Format | Required | Description |
| ----------- | --------------------- | -------- | ---------------------- |
| `firstname` | `string` | Yes | First name |
| `lastname` | `str` | Yes | Last name |
| `nickname` | `str` | No | Nickname |
| `birthday` | `date` (`YYYY-MM-DD`) | No | Birthday |
| `company` | `str` | No | Company name |
| `job` | `str` | No | Job title |
| `email` | `EmailStr` | No | E-mail address |
| `phone` | `str` | No | Phone number |
| `website` | `HttpUrl` | No | Website URL |
| `picture` | `HttpUrl` | No | Picture URL |
| `street` | `str` | No | Street number and name |
| `city` | `str` | No | City |
| `zipcode` | `str` | No | Zipcode |
| `state` | `str` | No | State or region |
| `country` | `str` | No | Country |
## Deployment
If you do not trust the official deployment, feel free to deploy your own!
[](https://vercel.com/new/git/external?repository-url=https://github.com/rclement/business-card-generator)
[](https://heroku.com/deploy?template=https://github.com/rclement/business-card-generator)
## Development
### Python
```bash
cp .example.env .env
pipenv install -d
pipenv shell
inv qa
flask run
```
### VSCode
If using VSCode, use the following configuration in `.vscode/launch.json`:
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: Flask",
"type": "python",
"request": "launch",
"module": "flask",
"env": {
"FLASK_APP": "business_card_generator.app:create_app",
"FLASK_ENV": "development"
},
"args": ["run", "--no-debugger"],
"jinja": true,
"envFile": "",
"justMyCode": false
},
{
"name": "tests",
"type": "python",
"request": "test",
"justMyCode": false
}
]
}
```
## Inspiration
- [GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats)
- [François Best Business Card](https://francoisbest.com/business-card)
## License
Licensed under GNU Affero General Public License v3.0 (AGPLv3)
Copyright (c) 2022 - present Romain Clement