QR Code generator is an online software that allows users to create QR Codes by entering desired information and download them in different formats - PNG, JPG, SVG, and EPS.
This project aims to create the best platform that allows users generate QR code for their various needs.
The primary goals are flexible sharing options (allow users download generated QR codes in png, jpeg, and pdf format or share the code via email / social media platforms) and promote personalised user history and archives. Secondary goals are to enhance user experience by allowing users customise generated codes to desired brand colours and good documentation comments.
The first thing to do is to clone the repository:
$ git clone https://github.com/zuri-training/Project-QR-Gen-Team-52-Backend.git
$ cd "parent directory"
Create a virtual environment to install dependencies in and activate it:
$ virtualenv --no-site-packages env
$ source env/Scripts/activate
Then install the dependencies:
(env)$ pip install -r requirements.txt
Note the (env)
in front of the prompt. This indicates that this terminal
session operates in a virtual environment set up by virtualenv
.
Once pip
has finished downloading the dependencies:
(env)$ cd project
(env)$ python manage.py runserver
And navigate to http://127.0.0.1:8000/
.
Upon registration 'Sign Up' a user is authorised and logged as an authenticated user with the following privileges;
An Unauthorised User are users who have not 'Signed Up' on the platform. They can do the following;
1) Client-Side Scripting / Coding
HTML (HyperText Markup Language)
CSS (Cascading Style Sheets)
JavaScript
2) Server-Side Scripting / Coding
Python
3) Wire frames, Moodboard, UI/UX Design, Protyping
Figjam https://www.figma.com/file/7ntQSfo6moEKgs6kwiR90X/Empathy-map%2FUser-story%2FUser-flow-for-QR-code-generator
Figma https://www.figma.com/file/1g4hAgOiGRBuPEJGPnRWKj/Zuri-Team-52-(Qr-generator)?node-id=0%3A1
(GitHub Usernames)
(These collaborators cannot push codes to the repo) 1) joshman58 2) tawakkul007 3) oyesolatobi 4) thintallqomar 5) solo-blaze 6) ojogwuchike 7) thephotosamurai 8) holuwamueewer 9) doyeen91 10) ben11997 11) ebehdeborah 12) lizzy-osuwa03
1) biyiemmy 2) kuriency 3) demiladeala 4) gloriaokeke 5) cheerycodes 6) sawlew 7) moyorbe 8) favtob 9) clappy203
To run the tests, cd
into the directory that has manage.py
, then run:
(env)$ python manage.py test app