Search packages, repositories and app categories

GitHub repositoryPr0nE/trip-brain-app

trip-brain-app

🌍✈️A full-stack AI-driven travel app built with Flutter, Go, and gRPC for personalized travel suggestions, rich insights, and offline access. Dive in and contribute! 🤝

trip-brain-app project cover
Stars
13
Forks
1
Last push (UTC)
Aug 26, 2023
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

Travel Brain 🌍✈️

Welcome to Travel Brain! Your go-to app for personalized travel suggestions tailored to your interests and dislikes. Get travel notes, historical background, and more!

Features 🌟

  • Travel Suggestions 🗺️: Get destinations that match your vibe.
  • Insightful Information 📚: Learn more about each place.
  • gRPC Communication ⚡: Fast and efficient backend communication.
  • Offline Support 📴: No internet? No problem!

Demo video

https://github.com/Pr0nE/trip-brain-app/assets/25032492/fbfaa7cf-057b-4380-acd9-17a3329fff5c

Architecture 🏗️

This project is organized into three main layers: UI, Data, and Domain. Each layer is in its own package to prevent code mixing.

  • UI Package 🎨: Widgets only, depends on domain.
  • Data Package 💾: Classes that produce domain language.
  • Domain Package 🛠️: Interfaces and models only.
  • App Package 📦: The glue that binds everything.

📝 Upcoming: Detailed article on architecture.

Getting Started 🚀

Prerequisites 🛠️
  • Flutter SDK
  • Docker
  • Firebase project
  • OpenAI API Key
  • Unsplash API Key
  • Google Client ID
API Keys and Client ID Setup 🔑
  1. OpenAI API Key: Required for natural language processing features.
  2. Unsplash API Key: Needed for fetching dynamic travel images.
  3. Google Client ID: For Google Sign-In authentication.
Firebase Setup 🔥

Provide these files for Firebase:

  • android/app/google-services.json
  • lib/firebase_options.dart
  • ios/firebase_app_id_file.json
  • ios/Runner/GoogleService-Info.plist
Step 1: Env Setup 🌱

Rename .env.example to .env and fill it out.

mv .env.example .env

📝 Note: Open .env and complete the variables.

Step 2: Docker Up 🐳

Run this to start Docker containers:

docker compose up -d

🟢 Success: Containers should be running.

Step 3: Flutter Run 🏃‍♂️

Run your Flutter app:

flutter run

Contributing 🤝

We welcome your help! Here's what you can do:

  1. Backend Refactor 🛠️: Assistance needed for refactoring Go code.
  2. Platform Testing 📱: Help needed for iOS and web.
  3. Testing 🧪: Tests are in progress.
  4. UI/UX 🎨: Room for improvement.

License 📄

MIT

Contact 📞

Questions? Reach out to [Mohammad Teimouri](mailto:moshi1376@yahoo.com).

Mohammad GitHub avatar
GitHub author

Mohammad ↗

LanguagesDartGoSwiftDockerfileJavaShellKotlinObjective-C

Flutter dependencies

App categories

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗