Fast-Check

FAST CHECK WEBSITE

An awesome Website allow attendance checking for teacher, leader
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The Fast-Check project will allow the user to

• Create and Manage room
• Create user
• Check members attendance through their webcam

I hope this project will help speeding up the checking attendance process

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Set up env file for project

1. client env Create a .env file in client root folder with content:

REACT_APP_CLIENT_ID = xxxxx.apps.googleusercontent.com (your client ID for google login feature)

Create a .env file in server root folder with content:

SECRET_KEY='SECRET'
DB_NAME='your name'
DB_PASSWORD='your pass'
DB_HOST='your host'
DB_PROD_HOST='your product db host'
DB_DOCKER_HOST='your docker db host'
RESULT_BACKEND = 'redis://{your_host}:{your_port}'
BROKER_URL = 'redis://{your_host}:{your_port}'
MAIL_SERVER='your mail server'
MAIL_PORT = 'your mailport'
MAIL_USERNAME = 'MAIL USERNAME'
MAIL_PASSWORD = 'your mail password'
MAIL_DEFAULT_SENDER="your mail default sender"

Installation

1. Clone the repo

   git clone https://github.com/Al3xDo/Fast-Check.git

2. Install NPM packages

   cd /client
   npm install

3. Install python packages

   cd .. # Go to the root of the repo
   cd /server
   pip install -r requirements.txt

(back to top)

Installation with Docker

1. Build and run

   docker-compose up

   (back to top)

Usage

You need to open 2 terminal, one for client and one for server For running production app, set environment varible API_ENV=prod

1. Run the client (first terminal)

   cd client
   npm start

2. Run server (second terminal)

   cd server
   python manage.py run

   for the first run, you need to initiliaze the database first

   python manage.py db init
   python manage.py db migrate
   python manage.py db upgrade

   then you can run server by

   python manage.py run

   Access http://localhost:3000/ to see the webpage

   (back to top)

(back to top)

Roadmap

• Allow User to upload their sample image
• Allow User to see their sample image
• Add 'login by google' feature
• Add 'change password' feature (send email verification)
• Add 'change email' feature (send email verification)
• Set up nginx
• Add diagram, database visulization
• Add 'kick participant' feature
• Add fake detect or liveliness detection
• Add 'Admin Dashboard'
• Speed up performance
• Multi-language Support
  • VietNamese
  • English

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Project Link: https://github.com/Al3xDo/Fast-Check/()

(back to top)

Acknowledgments

• https://mit-license.org/
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)