QR Create

Live Hosting Link👈

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. What are we building?
   • Project Documentation
   • Project Design Sketch
   • Tools Used
   • Database Schema
   • Mood boards
   • Features

About The Project:

A platform that allows users generate QR code that specifically does something when scanned.

We have attached the necessary links for better understanding of our project.

Project Documentation:

TeamSparrowpp QR_Generator Docs

Project Design Sketch:

TeamSparrowpp QR_Generator Design Sketch

Database Schema:

Database schema

Mood boards:

Mood boards

Github Project Organization:

TeamSparrowpp Github Projects

Project Status: in progress

Tools Used

• Design
  

• Frontend
  

• Backend
  

• Database
  SQLite3

• Version Tracking
  
  
  

Features

Create Account Users are able to sign up on QR Create with their email, username, and password.

Login Fetches users sign up details from our database, compares the login details and allows authenticated users gain full access to QR Create's Services.

Documentation All Users have full access to view and interact with the documentation.

Generate QR Codes Authenticated users can Generate Qr for Different use case, Email, Text, etc.

Download QR Codes Authenticated users Can download a generated Qr code into their Local Device as PDF, PNG, JPEG, JPG or Even SVG

Save QR codes Authenticated users Can save a Generated QR code to view Later

Share Authenticated users can share Generated QR codes to Twitter, Facebook or Even as an Email.

Responsive Allow user save data and come back to it..

How To Use Locally:

Requirements

• An IDE
• Git & GitHub
• A compatible browser
• Python 3.8+
  
  

Setup and Installation

In your IDE run the following commands in the terminal to setup

• Install environment in the root directory TeamSparrowpp-qr_gen

  pip install virtualenv

• Create the virtual environment in the same root directory

  • FOR WINDOWS USERS

    virtualenv <environment_name>

    • Activate virtual environment

      <environment_name>\scripts\activate

  • FOR LINUX USERS

    python3 -m virtualenv <environment_name>

    • Activate virtual environment

      source/<environment_name>/bin/activate

  
  

• Change directory

  cd qr_gen_team60/qr_gen_project/

• Install all packages/ Dependencies used

  pip install -r requirements.txt

• Run Migrations for the Apps

  python manage.py makemigrations accounts

  python manage.py makemigrations core

  python manage.py migrate accounts

  python manage.py migrate core

    python manage.py migrate

• Run Server

  python manage.py runserver

  
  
  

How to Contribute

• Fork the project repository
  In the project repository on github click the fork button in the upper right corner

• Clone the forked repository to your local machine

  git clone https://github.com/zuri-training/TeamSparrowpp-qr_gen.git

• Navigate to the local directory and open in your IDE/ Text Editor

• In the IDE terminal set upstream branch

  git remote add upstream https://github.com/zuri-training/TeamSparrowpp-qr_gen.git

• Pull upstream

  git pull upstream production

• Create a new branch to make your changes

  git checkout -b <your_branch_name>

• Stage the file After making edits, type the below command in your terminal

  git add <changed_files>

• Commit changes

  git commit -m "your_message"

• Push your local changes

  git push origin <your_branch_name>

• Create a pull request

• Wait till a QRCreate admin accepts and merges your pull request

  
  
  

Contributors

Name	Slack Username	Track	Email Address
Iniobong Effiong	SirNatz	Fullstack-Developer	Send a Message
Samuel Ibanga	Ibangajnr	Backend-Python	Send a Message
Nadia Ahmed	Nadia Ahmed	Fullstack-Developer	Send a Message
Ajiola Joel Oluwatofunmi	Joel Ajiola	Frontend-Developer	Send a Message
Eugene Tenadu Mensah	Ononero	Frontend-Developer	Send a Message
Isaac Oluwafunmi	---	Product Designer	Send a Message
Ruth Nelson	Rutty_nel	Product Designer	Send a Message
Aladimma Chioma	Clarie	Product Designer	Send a Message
Mfonabasi Akpan	Mfonabasi Akpan	Product Designer	Send a Message
Moses Yakubu	Moses Yakubu	Product Designer	Send a Message
Adewale Ogunyebi	---	Product Designer	Send a Message
Olamide Amosun	---	Product Designer	Send a Message
Chioma Onuoha	---	Product Designer	Send a Message
Abdulmalik Bolaji	---	Product Designer	Send a Message
Solomon Olorunfemi	---	Product Designer	Send a Message
Prosper Eromosele	---	Frontend & Python	Send a Message
Okoye Jachike	---	Python	Send a Message

What are You Waiting For?? Try out QRCreate Today!!!