Skip to content

Latest commit

 

History

History
108 lines (84 loc) · 3.54 KB

README.md

File metadata and controls

108 lines (84 loc) · 3.54 KB
Raw

Supporting Runr

Runr is an open source MIT application that was originally created to meet the needs of the organizers of the sporting event Course du bord de Saône. The support, maintenance and improvements are possible due to the contributions by community backers. If you are interested in supporting this project, please consider:

Introduction

The application Runr allow you to scan and check the bibs of Njuko or print the bib labels, one to one or in mass.

Features include:

  • Manage the editions with your email and password or directly with the identifiers and API keys given by the Njuko application
  • Search or scan the QR code of registration to validate the informations before collecting the bib
  • Indicate on the registration that the bib has been retrieved by the runner or collected by the organizers
  • Assign manually a bib number directly from the registration if the runner has not a bib
  • Search or scan the QR code of bib and print his label
  • Import in mass the list of bib numbers and print their labels
  • Install this application on your device's home screen without the need for an app store (it's a Progressive Web Application)
  • Direct connection with the Njuko APIs, so it is not necessary to use the local server La box Njuko

Installation

This part requires the applications below installed on your computer:

Project setup

yarn install

Compiles and hot-reloads for development

yarn run serve

Compiles and minifies for production

yarn run build

Lints and fixes files

yarn run lint

Deployment

This Progressive Web Application is deployed on the Github Pages services.

Deploy the application in your own Github repository

  1. Change the GIT url in the bin/deploy (linux/macos) or bin/deploy.bat (windows) file with your own Github repository
  2. Change the APP domain in the .env.production file with your own url of the custom Github Pages
  3. Create a CNAME in the DNS zone of your domain registrar with the domain of the Github User/Organization and your custom domain (format: <username-or-organization>.github.io.)
  4. Run the command yarn install
  5. Run the command bin/deploy (linux/macos) or bin/deploy.bat (windows)
  6. In the setting page of the your Github repository, and the Github Pages section:
  • Select the gh-pages branch for the Source field
  • Add your custom domain in the Custom domain field (already added by the deployment)
  • Check the Enforce HTTPS field
  1. Enjoy!

License

This application is under the MIT license. See the complete license in the bundle:

LICENSE

About

Runr is a François Pluchino initiative. See also the list of contributors.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.