https://github.com/betahuhn/qrgen

🔗 QrGen.cc lets you create QR-Codes and shortened URLs from any link quickly and easily
https://github.com/betahuhn/qrgen

express nodejs qrcode qrcode-generator typescript url-shortener vue vue-router vuejs vuex

Last synced: about 1 month ago
JSON representation

🔗 QrGen.cc lets you create QR-Codes and shortened URLs from any link quickly and easily

• Host: GitHub
• URL: https://github.com/betahuhn/qrgen
• Owner: BetaHuhn
• License: mit
• Created: 2020-05-06T17:15:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T03:04:57.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T16:48:18.357Z (8 months ago)
• Topics: express, nodejs, qrcode, qrcode-generator, typescript, url-shortener, vue, vue-router, vuejs, vuex
• Language: Vue
• Homepage: https://qrgen.cc
• Size: 4.67 MB
• Stars: 18
• Watchers: 4
• Forks: 5
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# qrgen.cc - QR-Code generator/url-shortener

[![Server](https://github.com/BetaHuhn/qrgen/workflows/Server/badge.svg)](https://github.com/BetaHuhn/qrgen/actions?query=workflow%3AServer) [![Client](https://github.com/BetaHuhn/qrgen/workflows/Client/badge.svg)](https://github.com/BetaHuhn/qrgen/actions?query=workflow%3AClient) [![Coverage Status](https://coveralls.io/repos/github/BetaHuhn/qrgen/badge.svg)](https://coveralls.io/github/BetaHuhn/qrgen)

QrGen.cc is a free service that lets you create QR-Codes and shortened URLs from any link quickly and easily

![gif](qrgen.gif)

## Live Website

The live version of this project can be found here: https://qrgen.cc

## Introduction

This repo contains the source code for the [qrgen.cc](https://qrgen.cc) QR-Code generator/url-shortener. Just add qrgen.cc/ infront of a url and get a QR-Code aswell as a short url. Alternatively you can visit [qrgen.cc](https://qrgen.cc) and create them manually.

The website is build with a Node.js/Express backend and a vue.js frontend. The built vue.js files are hosted by the express server.

## Note

There is also a Chrome/Firefox extension available. It lets you create a QR-Code/short URL by simply pressing the icon in your browser, or even with a keyboard shortcut. More info [here](https://github.com/BetaHuhn/qrgen-extension)

## Installation

Download the repo:

```

git clone https://github.com/BetaHuhn/qrgen

```

Change directory:

```

cd qrgen

```

Create .env file:

```

nano .env

```

Add:

```

DB_CONNECTION_STRING=Your MongoDB connection string; defaults to mongodb://localhost:27017/qrgen

PORT=Port the server runs on; defaults to 3000

```

Install dependencies:

```

npm run dependencies

```

Build backend and frontend:

```

npm run build

```

Start app:

```

npm run start

```

## Authors

* **Maximilian Schiller** ([@BetaHuhn](https://github.com/BetaHuhn)) - *Main contributor*

* **Alexander Janke** ([@alexanderjanke](https://github.com/alexanderjanke)) - *Conversion to Typescript*

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details