Skip to content

Latest commit

 

History

History
86 lines (49 loc) · 3.23 KB

README.md

File metadata and controls

86 lines (49 loc) · 3.23 KB
Raw

Vartalap

Vartalap is an open source personal chat application. It is design to provide the level of transparency in the personal messaging application with your data.

Supported Platform

  • Android
  • Ios

Features

  • Texts with emoji
  • Group Chat

Setup

Local setup

  • Download or clone the repo https://github.com/ramank775/vartalap.git

  • Get the required dependencies flutter pub get

  • Setup local chat-sever by following instruction in chat-server repo.

  • Create copy of config.json.tmpl to config.local.json (for development setup) and config.json (for production build).

  • Update api_url and ws_url of chat-server

Setup with Gitpod

Click on the Gitpod badge to start cloud IDE

Gitpod ready-to-code

Localhost command

  • Feel free to use your own ports configuration

    SMARTPHONE_INTERNAL_IP = 192.168.0.10

    SMARTPHONE_INTERNAL_PORT = 5555

  • To switch adb on your device to work over the network using port 5555

    adb tcpip SMARTPHONE_INTERNAL_PORT

  • Check connection from localhost

    adb connect SMARTPHONE_INTERNAL_IP:SMARTPHONE_INTERNAL_PORT

  • Ngrok tcp forward to your mobile or Forward a chosen port on your router

    ngrok tcp SMARTPHONE_INTERNAL_IP:SMARTPHONE_INTERNAL_PORT

Gitpod command

  • Connect from your Gitpod to your localhost for debugging adb connect NGROK_ADDRESS:NGROK_PORT

    flutter run

Chat Server

  • Start chat-sever by following instruction in chat-server repo.
  • Create copy of config.json.tmpl to config.local.json (for development setup) and config.json (for production build).
  • Update api_url and ws_url of chat-server

Contribution

Vartalap is an open source project. We are looking for building the community around the project, welcoming everyone or anyone who is interested in contributing.

  • Facing any issue? Raise an issue here with the necessary details.

  • Looking for a new feature? Raise an feature request here.

  • Found a security issue? Report it responsibility, view our security policy here.

  • Wants to resolve an issue? Thanks! initiate the discussion on issue of your choice.

Code Of Conduct

Contributor Covenant

Vartalap has adopted Contributor Covenant, we expect project participants to adhere to. Please read the full text to understand what action will and will not be tolerated.

LICENSE

GNU GENERAL PUBLIC LICENSE

Contact us