https://github.com/niteshthori24198/qr-insight

It is a web application that allows users to generate and scan QR codes, as well as provide analysis on QR code usage.
https://github.com/niteshthori24198/qr-insight

bcrypt bootstrap css expressjs html html5-qrcode ioredis javascript jwt mongodb mongoose nodejs qrcode winston

Last synced: 18 days ago
JSON representation

It is a web application that allows users to generate and scan QR codes, as well as provide analysis on QR code usage.

• Host: GitHub
• URL: https://github.com/niteshthori24198/qr-insight
• Owner: Niteshthori24198
• Created: 2023-05-01T09:15:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-01T18:07:21.000Z (2 months ago)
• Last Synced: 2024-10-11T04:25:18.113Z (about 1 month ago)
• Topics: bcrypt, bootstrap, css, expressjs, html, html5-qrcode, ioredis, javascript, jwt, mongodb, mongoose, nodejs, qrcode, winston
• Language: HTML
• Homepage: https://qr-front-end-niteshthori24198-niteshthori24198s-projects.vercel.app/
• Size: 1.98 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# QR-Insight

# Logo 

![logo](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/b0916c4d-8e36-4b6e-b90c-22cbafde918b)

# QR Code Generator, Scanner and Analysis

  This project is a collaborative effort by a team of 5 members, completed in a time span of 6 days. It is a web application that allows   users to generate and scan QR codes, as well as provide analysis on QR code usage. 

# Prerequisites

  - Node.js

  - npm modules

  - MongoDB

  - Redis

  - Git

  

# Installation

  - Clone the repository: git clone : https://github.com/Niteshthori24198/substantial-money-3994

  - Install dependencies: npm install

  - Start the server: npm run server

  

# Features

  - This project has the following features:

    - QR Code Generation

    - QR Code Scanner

    - QR Code Analysis

    - Download and Sharing

    - User Accounts

    - About Us Page

    - Blog Page

    - Contact Page

    - Good UI

    - Responsiveness

    - User-friendly

  

 # Table of contents

 

  ## QR-Insight/

  - backend/

    - config/

       - database.js

    - controllers/

       - QRController.js

       - userController.js

    - middlewares/

       - authentication.js

       - authorization.js

    - models/

       - userModel.js

       - QRModel.js

    - routes/

       - QRRoutes.js

       - userRoutes.js

    - index.js

  -  frontend/

     - public/

     - src/

     - css/

     - index.html

  - node_modules/

  - gitignore

  - package.json

  - README.md

  ## Home Page

  ![Homepage](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/a7f1163d-783b-4715-8c33-64e28fe0bbf9)

  

  ## ChatBot

  ![cb](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/64e691cf-9ab5-4049-bc66-d888ef01ed7e)

  ## Sign In / Sign Up Page

  The OAuth and GitHub Authentication features allow users to sign up and log in to the website using their Google or GitHub accounts.

  ![login](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/52eea794-8ce2-4df0-a177-40a18d85d35d)

  ![signup](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/f3c6cbcb-99d8-46bf-a34b-ed0b7c70a370)

  ## QR Code Generator Page

  The QR Code Generator page allows users to generate QR codes for text, URL, Wi-Fi, Zoom, WhatsApp, phone, vCard, and email. Users can     also download, print, or share the generated QR code via email or WhatsApp.

  ![Qr-generator](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/635ba397-9c17-4b31-bcce-3bade2f0f483)

  ## QR Scanner and Analysis Page

  The QR Scanner page allows users to scan QR codes using their device's camera or by uploading an image. The Scanner and Analysis page     provides statistical data and analysis on the usage of generated QR codes. 

  ![Scanner](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/ff3f1374-d092-4c17-a38d-9ee8d4a57a64)

  

  ## User Profile Section

  The User Profile section allows users to view their profile information, update their profile picture, and change their password.

  ![Profile-page](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/7308fc8c-9810-422e-8693-78cc79129df4)

  ## About Us Page

  The About Us page provides information about the project and the team behind it.

  ![Aboutpage](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/0944264b-2c8f-4590-a963-f0bcc2b4a07b)

  ## Blog Page

  The Blog page displays articles and posts related to the website's content.

  ![Blogpage](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/b12cc071-b1cc-4e0d-9277-18ddc35a1ba0)

  ## Contact Page

  The Contact page provides users with a form to contact the website's administrators.

  ![contact](https://github.com/Niteshthori24198/substantial-money-3994/assets/62844049/1fd54e1f-4fe8-4aef-ac48-6358627629b6)

  # Technologies Used

    This project was built using the following technologies:

   - Node.js

   - Express.js

   - MongoDB

   - Mongoose

   - Redis

   - HTML

   - CSS

   - Bootstrap

   - JavaScript

   - qrcode

   - html5qr code

   - Socket.io

   - bcrypt

   - JWT

   - OAuth

   - GitHub auth

    

  # Deployment

  - The backend of this project has been deployed using Cyclick, and the front end has been deployed using Netlify.

     - Front-End :  https://qr-front-end-niteshthori24198-niteshthori24198s-projects.vercel.app/

     - BackEnd : https://qr-insight-back-end-niteshthori24198-niteshthori24198s-projects.vercel.app/

     - Documentation : https://angry-cummerbund-newt.cyclic.app/doc/

     - Github  :  https://github.com/Niteshthori24198/substantial-money-3994

  # Team Members

  - Nitesh Kumar

  - Kishan Sharma

  - Venkatesh Tiwari

  - Rajesh Kumar

  - Pankaj Jain

  # License

    This project is licensed under the MIT License. See the LICENSE file for details.