The Login Process - adityashukzy/Maks GitHub Wiki

The graphic below can help you to understand how our Login process via the Maks website works.

The code for our website is up on a separate repository. As of now, the website is not hosted. To explore the website and try the login process on your local machine, you will need to follow the below steps.

Setting up the Maks website

  • Clone the maks-website repository.
git clone https://github.com/adityashukzy/maks-website.git

  • Open the directory structure in your preferred editor. Start a new terminal.

  • Install the npm modules.

npm i
  • Start the server and run the app in development mode.
npm run dev

Registering for an account

  • Click on the Register for an account button on the bottom-right of the card. Screen Shot 2021-05-13 at 13 54 45

  • Give a valid email address and a minimum 8-digit password. Screen Shot 2021-05-13 at 13 55 47

Logging into your account

  • Enter your email address and password. Screen Shot 2021-05-13 at 13 57 04

  • Explore your dashboard. The dashboard below is for an old account hence there is already some data on violators. This is to give an idea of what the dashboard usually looks like. Screen Shot 2021-05-13 at 13 58 43

Setting up the software on your local machine

Now you just need to follow the login steps given in the README of this repository. In short, you can log in via the login_app.py script, and begin using the software using the maks_app.py script.

Any violators caught will then be visible in your dashboard.