Skip to content

A super simple and minimalistic instant messaging system

Notifications You must be signed in to change notification settings

tmoon8730/JawApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JawApp

This is a collection of front-ends running off of a Firebase backend with the intended goal of running the absolute simplest instant messaging system. In a world where applications are getting more and more complicated with a billion features in them the JawApp is built with a simpler, minimalistic, vision. The goal is to have Android, iOS, and Web clients so that the simple messaging experience can be shared across most devices.

Getting Started

There are different development environment needs depending on which part of the project you are working on:

Android

For the JawAndroid project:

  1. Download Android Studio
  2. Request Firebase permissions
  3. Generate a google-services.json file from Firebase
  4. Copy the json file from step 3 into /JawApp/JawAndroid/app
  5. Vòla you should be able to run the Android application (either by an emulator or a connected device)

Web

For the JawWeb project:

  1. Install npm (different depending on your OS)
  2. Install the Firebase CLI tools by running npm -g install firebase-tools
  3. Authorize the Firebase CLI by running firebase login
  4. Make sure you are in the JawWeb directory then run firebase use --add and set the alias to your branch name

To run the nodejs project in the local environment run firebase serve from the JawWeb project. You should be able to see the project at localhost:5000

iOS

The iOS project has not been started yet :(

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

History

April 2017

  • Started JawAndroid application
  • Got basic version working

May 2017

  • Started JawWeb application
  • JawWeb application working
  • Current user and user read status on both JawAndroid and JawWeb
  • Added encryption to database stored messages

Authors

  • Tyler Moon - Main Developer / Owner - tmoon8730
  • Lawton Mizell - Main Developer - alcamech

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • Coffee
  • etc