Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 6.68 KB

README.md

File metadata and controls

83 lines (59 loc) · 6.68 KB

This project aims to be the ultimate resource for inline skating! It is built using SvelteKit and deployed to Netlify. The project is entirely written in TypeScript, with the exception of HTML and CSS in HTML and Svelte files of course. The website search is provided by Pagefind and the Telegram bot portion of the project is made using telegraf.js.

You can view the resources using either the Telegram bot or the website.


To use the Telegram bot, simply search @inlineskatebot on Telegram or click this link and use the /start command to start the bot.

Use the /help command to see how to use the bot.

Below is a list of the available commands for the Telegram bot. Use the /help command when interacting with the Telegram bot to get more details about each command.

List of bot commands

  • start - Starts the bot and displays a basic overview of what the bot does.
  • help - Displays information about how to use the bot and its commands.
  • terminology - Displays the common terms that are regularly used in inline skating.
  • tricks - Displays information about inline skating tricks.
  • trick_lists - Provides a list of trick lists for you to peruse.
  • rulebooks - Provides a list of official rulebooks for you to peruse.
  • buying_guides - Provides a list of buying guides for you to peruse.
  • maintenance_guides - Provides a list of maintenance guides for you to peruse.
  • glossaries - Provides a list of glossaries for you to peruse.
  • misc_resources - Provides a list of miscellaneous resources for you to peruse.
  • skate_boot_types - Displays information about the different types of skate boots.
  • skate_recs - Displays the recommended skates for beginners.
  • discount_info - Displays information about the tertiary student discount.
  • where_to_buy - Displays information about the places you can buy skates from.
  • where_to_rent - Displays information about the places where you can rent inline skates in Singapore.
  • skate_parks - Displays information about skate parks in Singapore.
  • skating_rinks - Displays information about skating rinks in Singapore.
  • brands - Displays information about the brands related to inline skating.
  • fr_differences - Displays information about the differences between the various FR skates.
  • f5s_vs_f6s - Displays information about the differences between the Flying Eagle F5S and the Flying Eagle F6S.
  • triskate_differences - Displays information about the differences between triskates and regular 4-wheeled inline skates.
  • accessories - Displays information about the accessories that you can buy for inline skating.
  • protective_gear - Displays information about the protective gear you can buy.
  • clothing - Displays information about the clothing you can buy, which are mostly just socks.
  • maintenance_items - Displays information about the maintenance items you might need to maintain your skates.
  • poll - Gets the bot to send a @countmeinbot styled poll message but with only one option called 'Coming'.
  • trg_msg - Gets the bot to send the training message that has been set up for your group.
  • trg_msg_help - Displays how to use the /trg_msg command if you have set it up.
  • rental_msg - Gets the bot to send the rental message that has been set up for your group.
  • rental_msg_help - Displays how to use the /rental_msg command if you have set it up.
  • create_poll - Create a @countmeinbot styled poll with custom poll options.
  • create_rental_msg - Create a rentals-oriented @countmeinbot styled poll with custom rental options.
  • qr_code - Gets the bot to turn your text into a QR code.
  • get_chat_id - Gets the bot to send the chat ID of the chat.
  • source - View the source code for the bot.

Click this link to visit the website!


Privacy

This project respects your privacy by collecting nearly no data about you. The website contains no ads, no trackers and no telemetry. It also doesn't use any cookies. The website only uses local storage to store your theme. You can verify this by auditing the source code.

The Telegram bot also doesn't collect any data about you except when you use the /qr_code command in inline mode. This is due to Telegram's Bot API not allowing the bot to send images stored in memory in inline mode. Telegram only allow bots to send an image that has either been uploaded to a website or has been sent in a Telegram chat previously. As such, the bot will send the generated QR code to a private Telegram group consisting of only the bot and the developer before sending the generated QR code to the chat in inline mode.

All this is to say that the developer will be able to see the QR code that you generated using the /qr_code command in inline mode. If you are uncomfortable with this, please do not use the /qr_code command in inline mode.

Other than the /qr_code command in inline mode, all other commands do not collect any information or send any data about you to anyone. Once again, you can verify this by looking through the source code. To reiterate once more, if you're uncomfortable with the developer being able to see the QR code generated by using the /qr_code command in inline mode, please do not use the /qr_code command in inline mode.


This project is licenced under GNU Affero General Public Licence Version 3 (GNU AGPL v3). For the full licence, look at the LICENCE.txt file.


Contributors

A massive thank you to Michelle for her help with the icons and her help with gathering all of the slalom trick videos. This project would have taken far, far longer to complete without her help. A big thank you to Aden for answering my questions regarding slalom tricks, and for agreeing to do a video for slalom tricks that were in the slalom trick list, but had no video on YouTube. Thank you to Ron too for answering all of my questions regarding slides. Lastly, thank you to another Michelle for her input on the colours associated with inline skating, as the light and dark theme of the website is based on her colour suggestions.