Tultul

Wala ka katultul? Gamita ang Tultul!

Note: README template borrowed here.

Table of Contents

1. About Tultul
   • Key Features
   • Built With
2. Installation
3. Manually Run the App
   • Prerequisites
   • App Installation
   • Server Setup
4. About the Team
5. Acknowledgments

About Tultul

Tultul is a public transportation app that assists users in commuting via jeepneys in Cebu. Tultul is designed for residents who regularly commute or are new to commuting through jeepneys in Cebu.

Tultul is Team Hacktose Intolerant's submission to the UP Komsai Week 2025 Hackathon Event managed by UPCSG.

(back to top)

Key Features

• Search Available Routes:
  • Suggested Routes: Tultul suggests available routes given an origin and destination locations.
  • Route Details: Users can view the total distance covered, total fare, and estimated time of arrival for each suggested route.
  • Filter by Fare: Suggested routes are filtered by the lowest fare, ensuring that users can easily see the cheapest route option.
  • View Fare Changes: Fares are automatically calculated based on the jeepney type (traditional or modern) and the passenger type (regular, student, senior citizen, PWD).
  • Real-Time Position Tracking: Users can set their current position as their origin/destination location.
• Jeepney Tracker
  • Real-Time Tracking: Tultul tracks the current positions of the jeepneys in real-time.
  • Map Tracking: Users can view the current positions of the jeepneys on the map view.
  • Tracking for each Jeepney Code: Jeepneys of a given jeepney code are displayed to the user.
• Route Follower
  • Step-by-Step Details: Users can view the step-by-step instructions on navigating along a given route.
  • Progress Tracking: Users can track their progress in following through the route.
  • Map Visualization: Users can view which path they should take on the map view.
• View Jeepney Routes
  • Display Route Coverage: Users can view the whole route coverage of a given jeepney code on the map view.
  • Select Jeepney Code: Tultul provides a set of jeepney codes whose route coverage can be displayed to the users.
• Voice Assistant
  • AI-Powered Route Recommendations: Tultul's voice assistant can suggest a route given specified landmarks.
  • Accessibility: Tultul's voice assistant can assist persons with disabilities in suggesting a route.

(back to top)

Built With

Flutter Django AWS

PostgreSQL Google Maps Platform FastAPI

(back to top)

Installation

You can download the versions of the app here.

(back to top)

Manually Run the App

The following steps below walk you through the process of running the app locally on your computer:

Prerequisites

This assumes that you already have installed and configured in your system Flutter for the front-end and Python for the back-end (it is preferable that you have the latest versions of both). This also assumes that you already have configured your access to Google Developer Console since this setup requires you to use your own Google Maps API key.

If you want to run the server locally, this assumes that you already have configured your own PostgresSQL database.

(back to top)

App Installation

1. Clone the repository

git clone https://github.com/rokkunbruv/hacktose-intolerant.git

2. Set current working directory to the frontend directory

cd frontend

3. Install necessary Flutter packages

flutter pub get

4. Configure app's custom splash screen (optional; you may want to do this if you want to display the custom splash screen on your end)

dart run flutter_native_splash:create

5. Configure app's custom launcher icon (optional; you may want to do this if you want to display the custom splash screen on your end)

dart run flutter_launcher_icons:generate

6. Create a .env file in the frontend directory and store your Google Maps API key there. You might want to refer to env.example to see how you can add your API key there.

7. Run the app through the terminal

flutter run

(back to top)

Server Setup

If you choose to run the server-side locally, you might want to follow these steps:

1. Ensure that the repository has been cloned to your system. If not, run

git clone https://github.com/rokkunbruv/hacktose-intolerant.git

2. Set current working directory to the commuteProj directory in backend

cd backend/commuteProj

3. Install necessary dependencies

pip install -r ../requirements.txt

4. Migrate database changes

python manage.py migrate

5. Create a .env file in the commuteProj directory and store your Google Maps API key and your PostgresSQL database credentials there. You might want to refer to env.example to see how you can add your API key there.

6. Run the server

python manage.py runserver

(back to top)

About the Team

(back to top)

Acknowledgments

• This README template is borrowed from the Best-README-Template Github repository
• The tech stack icons were generated using Profile Technology Icons
• The jeepney route polylines were obtained from Cebu Jeepneys Route Map
• The custom map style used on the map view is Interface map by samisel on Snazzy Maps.

(back to top)