Git Product home page Git Product logo

pubcrawler's Introduction

PubCrawler

Pub crawler demo app.

Note: Work in progress

This is an app listing pubs in the UK (pubs data downloaded from https://www.getthedata.com/open-pubs) with a realtime layer built on top to demonstrate Ably capabilities

Features

  • Nearby location search
  • Keyword search for pubs
  • Observation of presence at particular pubs
  • Join a pub using Ably's presence feature
  • Option to send a simple message when in a particular pub using Ably's publish/subscribe features
  • Offer a drink and follow up with back and forth communication using Ably's publish/subscribe features

To run this app simply checkout the repo

  • Open project in Android Studio (Arctic Fox 2020.3.1 Patch 2 was used to create the project)

For Google maps, you should set your API key on your local.properties file

  • MAPS_API_KEY = {your maps API Key} Please reach to me internally if you want to use my key

For Ably key

  • ABLY_KEY={your Ably API key)

-Simply build and run the project on a device or emulator

pubcrawler's People

Contributors

ikbalkaya avatar quintinwillison avatar

Stargazers

Patrick Lafleur avatar Ben Gamble avatar

Watchers

 avatar  avatar

pubcrawler's Issues

Add presence to map

Add / show user presence to map.
When users first open the map all present members must be shown using the new global channel.
Some users haven't yet identified themselves, they should still show on the map with an anonymous marker. Others can be shown simply by an avatar marker. Obviously avatar markers should be configured flexibly so that custom avatars could be introduced in the future.

Create a Coroutine based realtime interface

Realtime pub functions are currently served through a wrapper that handles messages from Ably through callbacks. Create an alternative interface that will allow clients to call those functions using coroutines.

Suspending functions returning values that are currently passed to callback lambdas would be convenient. Interface for this one could wrap other realtime classes so that it can take advantage of them while saving some work time

Create an alternative RealtimePub interface that use minimum amount of channels

RealtimePub class currently does not use channels very efficiently. Each message uses a unidirectional channel (from a user to another user) which is likely increasing the cost of using Ably.

Try to minimise these channels and use other means of filtering the messages. Maybe actions, events, anything that will help minimising number of channels.

Technical todo

  • Create another class DefaultRealtimePub(again, could be changed) that implements RealtimePub and uses less channels
  • Create a class that would provide those pubs using an interface (A factory)

Try to compare the cost of using those two. It could be a good example of efficient use of our platform

Create a chat UI that holds communication between users

Currently when a user sends a chat message or offer a drink to another user, messages are shown as toasts. It proves the point but it's not a great UI

Create a chat interface that will hold and store chats during a pub session. In this first iteration of this work, it's not necessary to think about the details of storage. Ably functionalities must be used whenever possible (message history)

UI should be simple but reusable. Possibly a new activity or fragment that holds a UI representing conversation between two pub goers. Make sure that this UI is not coupled with details of realtime activity. In the future it could be used for group chats too

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.