This is Not A QR Code Generator

A very simple web app intended as a school project, this project was used to learn CI/CD and Unit Testing

Demo: qr.foulopnneau.com · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • API
    • Build and run
    • Development
    • API Documentation
  • Webapp
    • Build and run
    • Development
• Contact
• License

About The Project

Not A QR Genertaor is a simple web app that allows you to generate Rickroll QR codes from a text input.

It provides an API to get random Rickroll QR codes plus a web app to gracefully display them. It also has the capability to generate real QR codes from the original text input.

Built With

API	Webapp
Nodejs	Nodejs
Express	Express
qrcode	PUGjs

Getting Started

API

Build and run (Production)

cd server
npm install
npm start

Development

cd server
npm install
npm run dev

API Documentation

Only two endpoints are available, one to get a random Rickroll QR code and one to get a Real QR code from the text input.

Method	Endpoint	Description
GET	/api/qr	Get a random Rickroll QR code
GET	/api/qr/real?text	Get a Real QR code from the text input

Webapp

Build and run (Production)

cd webapp
npm install
npm start

Development

cd webapp
npm install
npm run dev

Unit Tests

cd webapp
npm run test

Contact

Matthis Foulonneau - LinkedIn - Email

License

GPL-3.0 License