timy-messenger

(โ˜… 2,105)

Timy - open source mobile app for groups to communicate and organize themselves. Built with flutter.

  • .gitignore
  • .metadata
  • analysis_options.yaml
  • CONTRIBUTING.md
  • firestore-1.png
  • firestore-2.png
  • firestore-3.png
  • firestore-4.png
  • LICENSE
  • pubspec.lock
  • pubspec.yaml
  • README.md
  • timy.png

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/janoodleFTW/timy-messenger

Downloads the entire project code from GitHub to your computer.

cd timy-messenger

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd firebase/functions

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation