Giter Club home page Giter Club logo

tsml-ui's Introduction

TSML UI

TSML UI is a React web app that makes the 12 Step Meeting List interface available for use on any web page, regardless of platform.

Here's a demo of what the meeting finder looks like with no styling. Here's another demo embedded into a different design, with a Google Sheet as a data source.

To use TSML UI on your website you only need to add some HTML to your web page. To get started, use our TSML UI configuration helper.

Configure

Enable "Near Me" mode

You don't need to do anything other than enable HTTPS on your website. To ensure all users see this functionality, make sure that anyone who enters a http:// address for your site is redirected to the https:// address.

Debug mode

Trusted servants can append ?debug=true to the web address to see warnings in their browser's javascript console. For example, there is a warning about a bad conference_url at on this demo site.

This mode also disables caching so that changes may be observed by reloading.

Add custom types

Here is an example of extending the tsml_react_config object to include a definition for an additional meeting type.

var tsml_react_config = {
  timezone: 'Pacific/Honolulu',
  strings: {
    en: {
      types: {
        BEACH: 'Beach Meeting',
      },
    },
  },
};

A list of AA meeting types can be found in the Meeting Guide format spec.

Frequently asked questions

How are metatypes like "Active" and "Online" calculated?

Metatypes are types that are not specified explicitly in the data, they are inferred from the data based on this logic:

  • A meeting is considered In-Person if it doesn't have a type of Location Temporarily Closed and it has a specific street address.

  • A meeting is considered Online if it has a conference_url that matches our recognized formats and/or it has a conference_phone

  • A meeting is considered Active if it's In-Person or Online, otherwise it's Inactive.

Why no "Hybrid" type?

This app exists to help people find AA meetings, and after much discussion we decided that Hybrid was not a useful filter type for that purpose. We believe that people on the whole do not set out looking for a hybrid meeting, they simply want to know whether their online or in-person meeting happens to be hybrid. They will know this by its appearance in the list.

Second, while we can infer that a meeting is "online" if there is a Zoom URL (for example) in the listing, the app should not assume that, when there are online and in-person options, that means it is an actual "hybrid" meeting with a video screen and speakers in the room.

Web servants may add their own meetimg types of course.

Next steps

  • Hierarchical region dropdown
  • Alternate appearance of TC meetings (hide directions and cross out address)
  • Alternate appearance of approximate addresses (no location list group, zoom out map, no popup)
  • Display group info on inside page
  • Distance dropdown instead of regions when in near me or location mode
  • Spanish
  • French
  • Near location mode with geocoding
  • Accessibility improvements
  • Proper href attributes (instead of #) in controls for SEO
  • Filter-clearing buttons when no results
  • Select multiple dropdown items on mobile

Contributing

Pull requests are welcome. To get started, clone this repository, run yarn, and point your web root at the public folder.

While developing, run yarn watch to compile assets as you edit them. When you're ready to commit, run yarn prod to minify them for production.

Credits

This project uses React JS and Bootstrap CSS.

tsml-ui's People

Contributors

97eighty avatar blafving avatar cigzigwon avatar dependabot[bot] avatar flipperpa avatar josh-atl-062323 avatar joshreisner avatar leggomyinfo avatar mathteacher avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.