rclement / business-card-generator Goto Github PK

View Code? Open in Web Editor NEW

Generate digital QR-code business cards

License: GNU Affero General Public License v3.0

Shell 0.13% Procfile 0.29% Python 51.14% HTML 48.44%

business-card-generator's Introduction

Business Card Generator

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
vCard

Usage

The easiest way to generate a business card is to use the online web application.

You can also integrate URLs for website/keynotes integration using the following scheme:

https://business-card-generator.vercel.app/<card-type>.<card-format>?<card-parameters>

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!

Development

Python

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:

{
  "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
    }
  ]
}