Tea Share

Description

Tea Share is an online social media app for Android and the Web. It is built with Flutter for mobile (iOS/Android) and SvelteKit for the web version. It uses MySQL hosted on PlanetScale as the database, Go as the server side language and GCP Storage through Firebase Admin.

Currently, even though the Flutter project has a iOS folder, the iOS version is not configured for it and will not be available for a long time. (I don't have a MacBook)

Technologies

• TailwindCSS
• TypeScript
• SvelteKit
• Flutter
• MySQL
• Dart
• Go

Getting started

Installation

• Run this command to clone the project

git clone https://github.com/Dev-Siri/Tea-Share.git

Enter the directory for an app.

$ cd apps/web
  # OR
$ cd apps/server
  # OR
$ cd apps/mobile

• Install the dependencies for the web project before running the project.

$ pnpm i

• For the mobile version, you need to have the Flutter SDK installed on your system.

• And for the Server, you need to have Air if looking for live reload, & Go installed. To install it, run:

# with install.sh (preferred way according to air)
$ curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

# or you can use go install
$ go install github.com/cosmtrek/air@latest

• Then run flutter, pnpm or air to run the project locally.

# mobile
$ flutter run

# web
$ pnpm dev

# server
$ air

Connecting A Physical Device To The Flutter App.

In the Mobile directory, there is a connect.py script that allows you to connect to a physical android device with ADB.
Script usage:

$ python connect.py <IP-ADDRESS> <PORT>

Make sure your Android device is connected to your computer with USB and has Wireless Debugging enabled in the Developer Settings.

Testing The Production Version

Web

To build the web project, run:

$ pnpm build

Then to start the production version, run:

$ pnpm preview

Server

To compile the server version, run:

$ go build -ldflags "-extldflags '-static' -s -w" -o bin/tea-share

Then run the binary:

$ ./tea-share

Mobile

For building the mobile app for android, follow the official Flutter Documentation

License

This project is MIT Licensed - see the LICENSE.md file for details.