Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saravanasai/self-hosting-qr-code-generator
https://github.com/saravanasai/self-hosting-qr-code-generator
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/saravanasai/self-hosting-qr-code-generator
- Owner: saravanasai
- Created: 2023-07-12T02:12:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-03T05:19:00.000Z (about 1 year ago)
- Last Synced: 2024-11-11T23:42:29.097Z (3 months ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Self Hosting QR-code Generator
This is a simple project that can be self hosted for generating the QR-Code based on data you have been passed.
## Installation
To setup this project. clone this repository
```bash
cd project-root
```
```bash
npm install
```
```bash
npm start run
```
## Environment Variables
To run this project, you can rename the .env.example to .env & Configure PORT.
`PORT = 3000 //default port`
## API Reference
#### To generate QR-Code
```http
GET http://localhost:3000/generate-qr-code
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `data` | `string` | **Required**. Your data to generate as QR-code |
## Sample Response
```
{
code: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHQAAAB0CAYAAABUmhYnAAAAAklEQVR4AewaftIAAAKpSURBVO3BQa7jSAwFwUxC97/yGy+5KkCQ/KdNMMJ8sMYo1ijFGqVYoxRrlGKNUqxRijVKsUYp1ijFGqVYoxRrlGKNUqxRijXKxUMq
}
```
## Authors
- [@saravanasai](https://www.github.com/saravanasai)
## License
[MIT](https://choosealicense.com/licenses/mit/)