Skip to content
This repository has been archived by the owner on Jul 8, 2022. It is now read-only.

Huskydog9988/Salve

Repository files navigation

👋 Salve

Salve is an opensource automated sign-in sheet which puts a focus on signing-in by holding up your id.

🎯 Features

  • Sign-in by holding up your id
  • Automatic late detection
  • Assign names to ids
  • Realtime everything
  • Multiplayer (multiple sign-in stations)
  • Server Side Rendering
  • Highly portable (with docker)

⚡Quickstart

To start using Salve, please see our guide

💡 The Idea

Salve is a website that allows teachers and students to start classes more easily. Teachers can create a meeting on the website which tracks the arrival of students into their class. Students will go up to the computer and scan their IDs by holding up to the camera, and the system will log their name, time they enter into the meeting, and whether or not they were late based on that. The inspiration behind this project is seeing many minutes of class time wasted on role calls and determining who is absent or late. The world is shifting to modern technology, so why are we still waiting for students to respond "here"?

🥅 Goal

We want to cut the time it takes for classes to get started by removing the delays of attendance. By saving two minutes of class each day, we can save eight classes' worth of learning each school year, essential time. When we brainstormed Salve, we wanted to limit human interaction while maintaining efficiency. We decided that scanning a code is far more efficient than entering data, and wanted to implement a system that stores IDs and students' names making it easier for the teachers to determine who was present.

🏗️ Contributing

If you have found any issues within Salve or have any ideas of how to improve it, please open up a new issue.

If you would like to contribute code to Salve, please see our contributing guide.

⚠️ Licenses

Copyright (c) 2022-present Huskydog9988 and Lucas Sadoulet. Salve is free and opensource software licensed under the Apache License 2.0. The logo was designed by Huskydog9988 and uses assets from Twitter's Twemoji which is licensed under CC-BY 4.0.

A full breakdown of every dependency's license not mentioned here is provided. This includes the licenses for packages that Salve is indirectly using as well.

A special thanks to Eric Blade for their Quagga2 react example.