abhinayy0 / DQRCG

Dynamic QR Code Generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DQRCG

Dynamic QR Code Generator

About the project

DQRCG let's you generate dynamic qr code's for your website urls without any hassle. You can create dynamic urls and change your url any time you want.

Built With

(back to top)

Getting Started

Launch the app and go to the server and just start using.

Prerequisites

Install your dependencies using pip.

  • pip
    pip install -r requirements.txt

Installation

Setting up the server locally.

  1. Clone the repo

    git clone https://github.com/abhinayy0/dqrcg.git
  2. Create a virtualenv.

    python3 -m venv venv
    source venv/bin/activate
  3. Activate the virtual environment if you're using it. Install requirements

    pip install -r requirements.txt
  4. Make sure you're in the same working directory as your run.sh before executing the command.

  5. For (Linux/ Mac OS) launch using

    python3 services_manager build
    python3 services_manager run-server

    For windows launch using

    ./run.bat
    
  6. Now your app should be accessible at

    http://127.0.0.1:5000
    
  7. For setting up the frontend got to the client folder. Run the npm install command to create the node_modules of react app. More info about running react project can be found at this link.

  8. Adjust the backend api config.BASE_URL in config.js to point to your flask backend. Your project should now be working.

(back to top)

Usage

Below you can see the application home page asking for a url field to generate qr code. After providing the url you will get your generated qrcode.

Home Screen Genereated Code Validation Error

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Abhinay Yadav- @abhinayy0 - abhinayy0@gmail.com

Project Link: https://github.com/abhinayy0/dqrcg

(back to top)

About

Dynamic QR Code Generator

License:MIT License


Languages

Language:JavaScript 46.4%Language:Python 38.6%Language:HTML 14.0%Language:Shell 0.6%Language:Batchfile 0.3%Language:Procfile 0.1%