Träwelling is a free check-in service that lets you tell your friends where you are and where you can log your public transit journeys. In short, you can check into trains and get points for it.
- Check into trains and other public transport options in most of Europe
- Track your work trips, e.g. for tax returns and travel expenses
- Follow other people and see where they're going
- Meet new friends who are on the same train
- Find who's going to an event and is in your train
- Automatic sharing to Twitter and Mastodon
- Beautiful sharepics for e.g. Instagram Stories
- All texts in German and English
We're using the Laravel framework which depends on:
- PHP 7.2 (or higher)
- Composer
- NodeJS and npm
- A database of choice, e.g. MariaDB or SQLite (preferrably MariaDB)
- A local instance of db-rest v3
After setting up those things, you can clone the repository and get the dependencies:
composer install
npm installNow, you can create your own environment configuration:
cp .env.example .env
vi .envPlease change whatever sounds wrong to you. This is also the place to add API keys (e.g. for Twitter). While you will not need all of those, you can stumple into weird bugs.
Then, generate some application keys and migrate the database to the latest level:
php artisan key:generate
php artisan migrateLast, but not least, you can run npm run dev to build the frontend and watch for changes in the resources/ folder.
Use your webserver of choice or artisan (php artisan serve) to boot the application. You should see the Träwelling homepage.
Contributions are more than welcome. Please open an issue for bugs or feature requests. If you want to implement the feature - great; if you don't want to, that's fine, too.
If you add code:
- Please also commit the changes in the
public/folder, just asnpm run devproduces them. Yes, it's weird, but that's how we roll. - If you edit the language files, please check if your change is applicable for all languages.
- If you work on the front page (see screenshot above), please consider updating the screenshot.
- Unless you really want to work on Träwelling for a long time, we cannot support more languages. It would be sad to have half-baked languages that have missing strings after a while.
- Please consider adding unit and integration tests, especially if you're adding new features.
We are using the Affero General Public License (why?) - you are required to publish changes that you make to this software. Please refrain from creating your own public instance of Träwelling, instead try to create a better version for everyone.