deadbaed / epitok-web

Web client of epitok

epitok-web

Epitok is a library created to replace the token system in the Epitech school. This is the web client, which supports scanning student cards with QR codes on them to set students present to school events.

This project is written in Rust.

Licensed under MIT license.

An instance is available at token.epi.today. If you do not trust this instance or do not want to enter your credentials, feel free to deploy your own.

technologies

• epitok for the main logic
• actix-web for the web server
• askama for html templates
• bootstrap for css framework
• jquery for client side js
• qr-scanner for QR code webcam scanning, used at commit e8a77de

development

Tools required: rust and cargo. You can use rustup to install them.

Run cargo build to compile and cargo run to start the web server.

By default, the server listens on port 4343. Change this value with the PORT environment variable.

⚠️ Warning: The server listens on http only, which means that zero bytes will be encrypted! There is confidential data that will be transferred between the client and the server, please keep security in mind when deploying.

deployment

Run cargo build --release to compile with optimisations enabled.

The binary will be available at ./target/release/epitok-web.

Place the binary and the folder static/ in the same folder, it contains client side css and javascript.

You can also deploy with Docker by building the Dockerfile and using it. The instance token.epi.today is deployed that way.