/Team-Eagle-qr_gen

Primary LanguageHTMLMIT LicenseMIT

Repository for Team-Eagle QR_Generator

Table of Contents

Project Name

SMART QR

  • __The repository file will be arranged in the following order
  1. FrontEnd Folder contains the HTML,CSS and Javascripts code.
  2. BackEnd Folder that will contain all the backend code.

Framework for building

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

  • Design

    Figma

  • Project Management and Version Control

    GitHub

  • FrontEnd

    CSS  HTML  JavaScript 

  • BackEnd
    NodeJS
    Express

  • Database
    MONGODB

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 Guide

Visit the Repository to the Project on Github Website

    https://github.com/zuri-training/qr-gen-proj-team55

Fork the repository: Click the "Fork" button on the upper right corner of the Repo page.*

Make a local clone by:

  - Copying the URL for the forked Repo <br/>
       https://github.com/zuri-training/Team-Eagle-qr_gen.git <br/>
  - Create a Folder on your Local machine for the project <br/>
  - Open Command prompt / Terminal in the same folder location <br/>
  - In your Terminal, type: <br/>
       git clone https://github.com/zuri-training/Team-Eagle-qr_gen.git

Open terminal and set upstream branch: 

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

To add install all dependecies for contributors to begin work

    npm install

Pull upstream to get up to date with the original repo:

    git pull upstream main

Create a new branch for the task you are working on :

    git checkout -b branchName<br/>
(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)

When you're done with your task, do:

    git add <br/>
  • Commit your work with a message:
    git commit -m "message"

To avoid conflicts:

    git pull upstream main

Then push your branch:

    git push origin branchName - This creates the branch remotely and pushes to that branch on the Github

Go to Github and create a new pull request to the main branch. It will then be reviewed and merged into the master.

Contributors

BackEnd Contributors


FrontEnd Contributors

Designers


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.