Skip to content

This web application allows you to manage check-ins at multiple locations. Users can anonymously check-in by simply pressing a button.

License

Notifications You must be signed in to change notification settings

XDoubleU/check-in

Check-In 👉🔴

GitHub Main Workflow codecov GitHub last commit

This web application allows you to manage check-ins at multiple locations. Users can anonymously check-in by simply pressing a button. The app utilizes a websocket connection to display live location capacity on your website, allowing you to provide up-to-date information to your visitors.

Originally developed for Brugge Studentenstad, a non-profit organization that arranges student activities and manages study locations in Bruges, this app has been used to provide live capacity updates for each location on their website. Additionally, students are asked to select their school, providing Brugge Studentenstad with valuable data insights.


Rubens styled painting of students, with their backpacks and books, lining up to press a red round button on a big screen when arriving at a library. - Generated using Bing Image Creator.

How to run locally?

  1. Clone the repo
  2. Start the web-client, API and database using docker-compose up --build
  3. Apply migrations to database (in api dir) using make db/migrations/up
  4. Create admin user (in api dir) using make run/cli/createadmin u=admin p=admin
  5. Go to http://localhost:3000 for the web-client and http://localhost:8000 for the API

Websocket integration

An example on how to use the websocket integration on your own website can be found here.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

For more information please read the CONTRIBUTING document.

License

GPLv3

About

This web application allows you to manage check-ins at multiple locations. Users can anonymously check-in by simply pressing a button.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks