Skip to content

This is a website made for college canteen to make payments for bought items/products through their college ID card.

License

Notifications You must be signed in to change notification settings

bunny-k28/CanteenFastCard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CanteenFastCard

  • About
  • 1. This is a web based (single user) canteen-counter website.

    2. This website will help the students to pay for their bought items/products through their college ID card. All you have to do is, scan the college ID card or put your roll no. and pin-code.

    3. You just have to create a account on this with a initial/starting/activation amount. (For Ex.:- ₹50/-)

    4. You can also update your account when there's low balance.

    5. You can view/check their current/remaining balance/amount of their account by a simple click.

  • Preparing the Dir
  • 1. Before you start running the website or server.py file, you've to prepare your project dir with some files and folders.

    2. To do so, you'll find a setupEnv.py file in the directory.

    3. Open your CMD/PowerShell/Terminal inside the project directory and type

    • For Win32/64
         py .\setupEnv.py
    
    • For MacOS
        python3 ./setupEnv.py
    

    4. After the program has finished preparing your directory, you have to make some modifications in the site_settings.env.

    • Env Vars
        1. HOST='0.0.0.0'
        2. PORT=<port_number>
        3. DEBUG=<bool>
    
        4. SMTP_SERVER='smtp.<smtp_server>.com'
        5. SERVER_PORT=<smtp_server_port> (Default Port: 465)
    
        6. HOST_SSID="<service Email account, for sending emails and 2FA codes>"
        7. HOST_KEY="<app password of service Email account>"
    
        8. MASTER_EMAIL="<a master/personal email address for admin work>"
        9. MASTER_PROCESS_KEY="<a custom keyfor registration verification process>"
    

    5. After running the setup file. You'll be able to run the server file

    • For Win32/64
        py .\server.py
    
    • For MacOS
        python3 ./server.py
    


  • Getting Started
  • 1. Register

    [ There are 2 ways to register your ID card. One automatic, one manual. ]

    1.1. In auto mode, when you'll scan your ID card or put your credentials manually. The website will automatically open the registration form if the ID is not registared. After you'll fill up your details in the registration form, the canteen employee will enter the Master Key as per the verification process. Then you can click the Register button to register.


    1.3. In the manual mode, you have to manually register yourself by clicking on the Register button present in the top right corner. After you'll fill up your details in the registration form, the canteen employee will enter the Master Key as per the verification process. Then you can click the Register button to register.


    2. Login

    [ There are two ways to login to your account. One by scanning ID-card, one by entering roll no. and password/pin-code. ]

    2.1. One way to login is, by scanning your college ID card. Click the scan your ID-Card button. Place your ID card in front of the webcam and there you are. You'll be logged-in.

    2.2. Another way to login is, bu entering your roll no. and your login-pin-code. After entering your credentials just click the confirm identity button, and there you are. You'll be logged-in.

    3. Password/Pin-Code Reset

    [ There are 2 ways to reset your account password/pin-code. One by reset link, one by posting request. ]

    3.1. On the login page, you'll see a reset link in red. The link will take you to the reset password/pin-code form. Before filling up the reset form, you have to verify your Identity 1st. Then you'll fill-up the required fields and that will reset your password/pin-code.

    3.2. Another way is by posting a password/pin-code reset request to the admin(s) on the discord server channel or posting a reset request through this E-mail:- [email protected]. Just send your:-

    1. Roll Number
    2. USID
    3. New Password/Pin-code
    

  • How to use (~the dashboard)
  • [ Once you've logged-in, you'll be in your CanteenFastCard dashboard from where you can pay for your items, check your account balance, put more amount into your account and you can also view/request your transaction(s) log file (or receipt). ]

    1. Payment

    As you can see in the above image, you just have to enter the total amount of the bought item(S) and then the canteen employee will enter the your pin code as per the verification process. Then click the Pay Amount button.


    2. Update

    As you can see in the above image, you just have to enter the amount you want to update/deposite into your account and then the canteen employee will enter the your pin code as per the verification process. Then click the Update Balance button.


    3. Check

    As you can see in the above image, you just have to click the Check Balance button and you'll be able to check your current account balance.


    4. Log

    As you can see in the above image, there are 2 buttons. One, the View Transition button to view the transaction history/log in the browser. Second, the Request File button, this request button will mail you a softcopy of your transaction history/log.