aphexddb / contactqr

QR code creator so smartphones can easily read your contact information

ContactQR

This project creates QR Codes for your contact information that can be read with a modern smartphone. Most phones expect information in a vCard format. For example, iPhones will scan a QR code automatically when the camera is open. Released under the MIT License.

The project was inspired by a friend who had one of these QR codes on their lock screen. This enabled people to simply scan the code instead of sending a text message to exchange contact info.

Visit https://www.contactqr.me to see it in action.

Releasing

To build a release update the VERSION file (if needed) and run:

make docker_build

To push a release

make docker_push

Development

To run the server for development:

make dev

Or run the container:

make docker_build
make run

To run the UI for development:

cd ui
make dev

Create a new vCard via curl

curl -d "{\"first\":\"Jane\",\"last\":\"Doe\",\"title\":\"Mushroom Farmer\"}" -H "Content-Type: application/json" -X POST http://localhost:8080/api/v1/vcard/create

Requirements

• UI built with Gatsby using npm 5.6.0 and node v8.11.2.
• Server built using Go 1.11.

Notes

The vcard package treats VCard as immutable by using the functional option pattern to build the vCard and getters to read data. Please feel free to use this package for your project! The tests are also in a seperate tests package to validate that private variables are treated appropriately.

If you find this useful, please report any bugs or add a feature!