search

zuri-training / qr-gen-proj-team55

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
MIT License
3 stars 24 forks source link
css django html5 javascript python

readme

Repository for Team 55 QR_Generator

Project logo

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

  1. FrontEnd Folder contains the HTML,CSS and Javascripts code.
  2. ContributionList is a folder that contains a txt files of every contributed Team members.
  3. qr_gen folder contains all the codes use in evecuting this project with subfolder such as
    • authentication, Apllication folder for the CustomUser and Profile models as well as other .py files in an app, it also contains templates folder for all jinja related to authentication
    • qr_gen_app, this is the second applcation folder that how all the functionalit of the qr_generation.
    • static, this contains all the static folders such as the CSS; IMAGEs and the JS files.
    • templates contains a based templates file that is extended in all templates file.
    • qr_gen is the the project folder.
  4. requirements.txt contains the dependencies installed throughout the project.

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

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:

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

Product Specialization

Project Status

Project is : in progress

Contributors

BackEnd Contributors

FrontEnd Contributors

Designers

Deployment Instruction

  1. Create a folder mkdir folder_name
  2. Change directory to the folder: cd folder_name
  3. Clone main branch to folder: git clone --branch main https://github.com/zuri-training/qr-gen-proj-team55
  4. create virtual environment: python -m virtualenv local
  5. Activate virtual environment: local\Scripts\activate
  6. Install packages: pip install -r requirements.txt
  7. Create database, database_user and password for the project: PostgreSQL database
  8. To generate a new secret key and add it to ,env file created in the page python manage.py generate_secret_key
  9. Create a new file .env and copy the contents of .env_template into it and replace:

Relevant Links

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.