Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dev-siri/tea-share
Tea Share is a social media application made for Android in Flutter and the Web with TypeScript & SvelteKit.
https://github.com/dev-siri/tea-share
android dart flutter golang mobile mysql planetscale social-media sql svelte sveltekit tailwindcss
Last synced: 7 days ago
JSON representation
Tea Share is a social media application made for Android in Flutter and the Web with TypeScript & SvelteKit.
- Host: GitHub
- URL: https://github.com/dev-siri/tea-share
- Owner: Dev-Siri
- License: mit
- Created: 2022-08-19T08:01:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T18:14:30.000Z (over 1 year ago)
- Last Synced: 2023-10-23T22:24:07.719Z (over 1 year ago)
- Topics: android, dart, flutter, golang, mobile, mysql, planetscale, social-media, sql, svelte, sveltekit, tailwindcss
- Language: Dart
- Homepage: https://tea-share.vercel.app
- Size: 21.2 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Tea Share
## Description
Tea Share is an online social media app for Android and the Web.
It is built with **[Flutter](https://flutter.dev)** for mobile (~~iOS~~/Android) and **[SvelteKit](https://kit.svelte.dev)** for the web version. It uses **[MySQL](https://www.mysql.com)** hosted on [PlanetScale](https://planetscale.com) as the
database, **[Go](https://go.dev)** as the server side language and **[GCP Storage](https://cloud.google.com)** 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
```sh
git clone https://github.com/Dev-Siri/Tea-Share.git
```
Enter the directory for an app.
```sh
$ cd apps/web
# OR
$ cd apps/server
# OR
$ cd apps/mobile
```
- Install the dependencies for the web project before running the project.
```sh
$ pnpm i
```
- For the mobile version, you need to have the [Flutter SDK](https://docs.flutter.dev/get-started/instal) installed on your system.
- And for the Server, you need to have [Air](https://github.com/cosmtrek) if looking for live reload, & [Go](https://go.dev/dl) installed. To install it, run:
```sh
# 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.
```sh
# 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](apps/mobile/connect.py) script that allows you to connect to a physical android device with [ADB](https://developer.android.com/studio/command-line/adb).
Script usage:
```sh
$ python connect.py
```
Make sure your Android device is connected to your computer with USB and has [Wireless Debugging](https://medium.com/android-news/wireless-debugging-through-adb-in-android-using-wifi-965f7edd163a) enabled in the Developer Settings.
### Testing The Production Version
#### Web
To build the web project, run:
```sh
$ pnpm build
```
Then to start the production version, run:
```sh
$ pnpm preview
```
#### Server
To compile the server version, run:
```sh
$ go build -ldflags "-extldflags '-static' -s -w" -o bin/tea-share
```
Then run the binary:
```sh
$ ./tea-share
```
#### Mobile
For building the mobile app for android, follow the official [Flutter Documentation](https://docs.flutter.dev/deployment/android)
## License
This project is MIT Licensed - see the [LICENSE.md](LICENSE.md) file for details.