HopHub

HopHub is a ride sharing platform that aims to simplify common commutes to and from events and thereby make the world a little bit better. No matter if you fill up your car, share a train ticket, arrive by bus, plan a bike tour or walk.

This project is implemented using Ruby on Rails.

The reference implementation is available at hophub.xyz but you can also host your own instance as long as you comply with the AGPL-3.0 License.

How it works

Create an event

You create a new event and share the link with potential attendees. Only people with the link can see the event.

Add an offer

People that want to propose a ride can now add an offer. This works for free seats in a car as well for a common train ride, a bus trip, a bike tour or a walk. No login is required, only an email address. As soon as the email address is confirmed, the offer is shown on the website so others can see it.

Add a request

People who are looking for a ride but don't see a matching offer yet can add a request. Also here, no login is required, only an email address.

Get in touch

When two parties match, they can get in touch with each other using a form on the website. The email address of the person reaching out is used as the Reply-To address, so the recipient can reply directly for further coordination.

Leave no traces

Offers, requests and events that are no longer valid are automatically and permanently removed from the database.

Features

This project takes care to be as data protection friendly as possible. It only stores the data that is necessary to provide the service and does not use 3rd party cookies. It also does not use any tracking or analytics tools.

• Users can create events
• Users can see events if they are provided with the link
• Users can add offers and requests to events
• Users can see the offers and requests of an event
• Users can contact other users through the platform via email
• "Clean driver" feature: Offers by car can be set to "driver needed", and requests can be set to "offering to drive"
• Events, offers and requests are automatically deleted after they have passed
• Maptiler is used to display offers and requests on a map
• Admins can see all users, events, offers and requests
• Admins can delete users, events, offers and requests
• Altcha is integrated as captcha for all forms
• Localization

Installation

Requirements

• Ruby 3.3
• Rails 7

Setup

1. Clone the repository

2. Install the dependencies

bundle config set --local path 'vendor/gems'
bundle install

3. Create the database

bundle exec rails db:create
bundle exec rails db:migrate

4. Start the server

bundle exec rails server

Configuration

The following table lists all environment variables that are used by the application. You can set them in some env file magic, export them in your shell or use the Cuberfile to deploy on k8s.

Environment variable	Description
SECRET_KEY_BASE	A secret string for the Rails application. Generate it with rails secret
ALTCHA_HMAC_KEY	A secret string for the Altcha HMAC algorithm. Generate it with rails secret
MAPTILER_API_KEY	A MapTiler API key. Obtain one from https://cloud.maptiler.com
HOPHUB_BASE_URL	The base URL for the Rails installation
HOPHUB_DATABASE_USERNAME	The username for the SQL database
HOPHUB_DATABASE_PASSWORD	The passwort for the SQL database
HOPHUB_DATABASE_HOST	The SQL database host name
HOPHUB_DATABASE_PORT	The SQL database host port
HOPHUB_DATABASE_NAME	The name of the SQL database
HOPHUB_MAIL_SERVER	The host name of the SMTP server
HOPHUB_MAIL_PORT	The port of the SMTP service
HOPHUB_MAIL_FROM	The email address to be used as From address in outgoing emails
HOPHUB_MAIL_DOMAIN	The domain to be used in outgoing emails
HOPHUB_MAIL_USERNAME	If your mail server requires authentication, set the username in this setting
HOPHUB_MAIL_PASSWORD	If your mail server requires authentication, set the password in this setting
HOPHUB_SINGLE_EVENT_ID	Optional ID of a single event that is always shown on the landing page
EXCEPTION_NOTIFIER_SENDER	Optional sender for notification emails
EXCEPTION_NOTIFIER_RECIPIENT	Optional addresses of recipients for exception notification emails
PLAUSIBLE_DOMAIN	The domain of the Plausible instance for the privacy policy
PLAUSIBLE_SRC	The source of the JavaScript script for Plausible

HTTP routes

Please make sure to protect the /admin path with through something like HTTP basic auth or other methods in your deployed HTTP server. The application itself does not manage user accounts and roles, and without external protection all data is public.

Similarily, the the /metrics and /up paths are probably also something you want to protect.

Run tests

bundle exec rails test

Micro CMS

The project features a very minimalistic content management system for static text rendering with Markdown. These texts are stored in a model called 'Content' and are rendered by the ContentsController. The content is stored in the database and can most easily be edited through the admin interface. Each entry has a unique key that is used to identify the content in the view and a locale attribute that is used to determine the language of the content. A fallback flag can be set to determine if the content should be used as a fallback for other languages.

The following keys are used in the project:

• tos: Terms of Service
• privacy: Data privacy policy
• imprint: Imprint
• instance-info: Information about the instance, displayed on the landing page

Single event deployment

If you want to deploy the project with a single event that is always shown on the landing page, you can set the HOPHUB_SINGLE_EVENT_ID environment variable to the ID of the event. Request to the landing page will then be redirected to the event page of the event with the given ID.

Note that the creation of events is not possible in this mode. The event with the given ID must be created manually through the admin interface or the Rails console.

Plausible analytics

The project features an integration with Plausible for privacy-friendly analytics. Plausible is a lightweight and open-source web analytics tool that doesn’t use cookies and is fully compliant with GDPR, CCPA and PECR. The application scaffold includes the Plausible JavaScript script with the domain and source that are set in the PLAUSIBLE_DOMAIN and PLAUSIBLE_SRC environment variables. If these variables are not set, the Plausible script is not included in the application layout.

Cleanup task

The project features a cleanup task that has to be run periodically to remove old events, offers and requests from the database. The task is defined in the lib/tasks/cleanup.rake file and can be executed with the following command:

bundle exec rails hophub:cleanup

The Kubernetes deployment will add a cronjob that runs this task every hour.

Data privacy

If you host the project yourself you should be aware of the data privacy implications and legal requirements in your jurisdiction.

Consider the following aspects when crafting the privacy policy for your instance:

• The project does not use any cookies except for the session cookie that is required for the functionality of the website.
• The project does not use any tracking or analytics tools.
• For events, the following data is stored in the database:
  • The title of the event
  • The ID of the event, derived from the title
  • The description of the event
  • The end date and time of the event
  • The email address of the creator of the event
• Events are automatically deleted from the database after they have passed
• Events can be deleted manually by their creators
• For entries (offers and requests), the following data is stored in the database:
  • The ID of the entry
  • The email address of the creator of the entry
  • The name/pseudonym of the creator of the entry
  • The optional phone number of the creator of the entry
  • The event ID of the event the entry belongs to
  • The type of the entry (offer or request)
  • The number of seats available or needed
  • The mode of transportation (car, train, bus, bike, walk)
  • The departure/arrival location
  • The departure/arrival date and time
  • The departure/arrival latitude and longitude
  • The message of the creator of the entry
  • The "clean driver" flag
• Entries are automatically deleted from the database after they have passed
• Entries can be deleted manually by their creators
• When a user contacts another user through the platform, the email address of the sender is used as the Reply-To address in the email. Neither the email address of the sender nor the text they write is stored in the database.
• The GDPR information tool allows users to query the data stored in the database for a given email address. The tool sends an email to the given email address, containing a list of all events, offers and requests that are associated with the email address with links to delete the data.
• Maptiler is used to display offers and requests on a map. The browser of the client sends a request to the Maptiler API to retrieve the map tiles. The IP address of the client is sent to the Maptiler API. More information can be found in the Maptiler privacy policy.
• JsDelivr is used to deliver JavaScript files of the project. The browser of the client sends a request to the JsDelivr API to retrieve the files which transmits their IP address to the JsDelivr API. More information can be found in the JsDelivr privacy policy.
• If you use the Plausible analytics integration, you should inform your users about the data that is collected by Plausible. More information can be found in the Plausible privacy policy.

GDPR information tool

The project features a GDPR information tool that allows users to query the data stored in the database for a given email address. The tool sends an email to the given email address, containing a list of all events, offers and requests that are associated with the email address with links to delete the data.

Metrics

The /metrics route can be used to query statistical data from the HopHub instance in a format suitable for consumption by Prometheus. The /up route can be used for healt checks of the instance with something like Kubernetes.

Contributing

Reporting issues

If you find a bug or have a feature request, please report it in the issue tracker.

Contributing code

1. Fork it
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a new Pull Request

Add localization

If you want to add a new language, please follow these steps:

1. Add a new file in the config/locales directory. The file should be named after the language code (e.g. en.yml for English, de.yml for German, etc.). The file should contain a hash with the translations. The keys should be the same as in the en.yml file.
2. Create new mailer views in the app/views/event_mailer and app/views/entry_mailer directories. The file names must contain the language code (e.g. de for German). The content should be the same as for the en versions.
3. Add the new language to I18n.available_locales in the config/locales.rb file.
4. Open a pull request.

Donations

If you like the project and want to support its development, you can donate through Ko-fi:

License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details