Skip to content

Latest commit

 

History

History
187 lines (142 loc) · 6.53 KB

README.md

File metadata and controls

187 lines (142 loc) · 6.53 KB
Raw

Repository for Team 55 QR_Generator

Table of Contents

Project Description

This project involve building a web site for generating a (Quick Response) qr_code where user that visit the site can only generate the code after registration. The code generated should also be able to use both on and offline and can be shared via email, can be downloaded in PNG and PDF

Problem statement

With the evolution of Technology, quick access to service using an encrypted method has been evolving over the years, platform for the creating this encryption is what we will be building.

Framework for building

  • IDE
    The project is was built using the Visual Studio Code Editor and the following technologies were used:

  • Project Management and Version Control

    GitHub

  • Design

    Figma

  • FrontEnd

    CSS  HTML  JavaScript 

  • BackEnd
    Python Django

  • Database
    MySQL

Contributors Guide

  1. Visit the Repository to the Project on Github Website https://github.com/zuri-training/qr-gen-proj-team55
  2. Fork the repository: Click the "Fork" button on the upper right corner of the Repo page.*
  3. Make a local clone by: Copying the URL for the forked Repo
    https://github.com/zuri-training/qr-gen-proj-team55
    Create a Folder on your Local machine for the project
    Open Command prompt / Terminal in the same folder location
    In your Terminal, type:
    git clone https://github.com/github_username/qr-gen-proj-team55.git
  4. Open terminal and set upstream branch:
    git remote add upstream https://github.com/zuri-training/qr-gen-proj-team55
  5. To add install all requirement for contributors to updates packages run on cloned terminal:
    pip install -r requirements.txt
  6. Pull upstream to get up to date with the original repo:
    git pull upstream main
  7. Create a new branch for the task you are working on :
    git checkout -b branchName
    (Make sure your branchName is descriptive in context to the feature you are working on. Also be sure to check which branch you are on using git status before you begin working)
  8. When you're done with your task, do:
    git add
    • Commit your work with a message:
      git commit -m "message"
  9. To avoid conflicts:
    git pull upstream main
  10. Then push your branch:
    git push origin branchName - This creates the branch remotely and pushes to that branch on the Github
  11. Go to Github and create a new pull request to the main branch. It will then be reviewed and merged into the master.

Features of the Website

Unauthenticated users - An individual that has not registered to the website would be able to:

  • Visit the platform to view basic information about it
  • View and Interact with the documentation
  • Register to view more details
  • No access to use until registered

Authenticated Users - A user that has fully registered and has completed all the verification processes in the website:

  • Full access to the platform
  • Allow setting on what should happen when qr is scanned - give at least 2 options.
  • Allow users to download (allow png, jpg and pdf download format), or share code by email or social media.
  • Allow users to save data and come back to it

Product Specialization

  • Mobile Phones
  • Tablets
  • Laptops

Project Status

Project is : in progress

Contributors

Designers

  • Itepu precious eden https://github.com/preciousitepu

  • Timileyin Lasisi https://github.com/Timileyin21

  • Abimbola Ashonibare https://github.com/BimboOni

  • Badamosi Abdullahi Oluwatobi https://github.com/Abdooorl

  • Zipporah Badi https://github.com/Zeebadi

  • Nnoruka Anthonia https://github.com/Antoruka

  • Uduak Oscar https://github.com/Udyoscar

  • Barakat Muraina Omolara https://github.com/bara506

  • Ekojawe Efe https://github.com/efedivine

  • Falola Samuel https://github.com/sammiecode

  • Daniel Ige https://github.com/igedaniel96

  • Emediong Ebong https://github.com/Emyebong

  • Oluwabusayo Basirat Atiku https://github.com/Busayoatiku


BackEnd Contributors

  • David Ilori https://github.com/Ddluwole

  • Awal Umar https://github.com/drizla01

  • Joshua Eze http://github.com/Allenkeys

  • Dighomanor Jeremiah http://github.com/Digho007


FrontEnd Contributors

  • Mark nehemiah http://github.com/markben2122

  • Samson Vershima Saaikyaa http://github.com/vershima2

  • Awelewa Oluwasanmi Omolade http://github.com/Sanmi01

  • Akobi, Mutiat Adeoti https://github.com/PhoenixClix

Relevant Links

  • Figma Design
  • FigJam Design
  • BackEnd Schema
  • Design Documentation

API Details

Acknowledgements

Special thanks to Zuri Team and I4G for giving every member of this Team the privelege to Learn as well as implement what they have have in a real life settings.