Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 3.07 KB

README.md

File metadata and controls

57 lines (41 loc) · 3.07 KB
Raw

Soundscape Web Client

The Soundscape web client provides a Soundscape-like experience by announcing nearby points of interest and intersections and playing audio beacons, all with spatial audio.

Try it for yourself! https://soundscape-community.github.io/soundscape-web-client/

Screenshot of Soundscape web client

This project aims to make both the user and developer communities for Soundscape more inclusive:

  1. Unlike the original iPhone app, users do not need an iOS device. By running in a browser, the Soundscape web client works on any platform. You can use it not just on iPhone, but also Android, and even Windows.
  2. Developers do not need a Mac or comfort with Xcode to contribute. Web technologies are approachable and familiar to many developers who are interested in improving the software.

Contributing

Help is welcome! Please see the issue board for items that need attention, and below for some tools to aid in development and debugging.

Activity simulator

Screenshot of GPX file replay view

Select a local GPX file from your computer, and it will be replayed on a visual map with audio callouts.

https://soundscape-community.github.io/soundscape-web-client/#/gpx

Location override

To use a location other than what's reported by your device, you can include the latitude and longitude in the URL, e.g. https://soundscape-community.github.io/soundscape-web-client/#/fixed/38.897600/-77.006156 will place you near Union Station in Washington, D.C. The compass heading will follow your mouse pointer.

Running the app on your own machine

  1. Install dependencies, build the app, and start the server

    npm ci && npm run build && npm start

    The app should now be running and accessible over HTTP from a web browser at http://127.0.0.1:8080/

  2. For the app to work properly from your phone, you'll need to serve it over HTTPS. The easiest way to do this is via a tunnel, such as:

    1. ngrok: ngrok http http://127.0.0.1:8080/
    2. Microsoft Dev Tunnels: devtunnel host -p 8080
    3. Many other tunneling options

Running the Android version

  1. Build and sync the app: 
    npm ci && npm run build && npx cap sync
  2. Open it in Android Studio and run it from there: 
    npx cap open android
    From Android Studio, you can run it either in an emulator or on a real device.

Update Splash Screens and Icons (Android)

Just place your images as described in in \assets https://capacitorjs.com/docs/guides/splash-screens-and-icons and run npx capacitor-assets generate --android.

Third-party libraries used

  1. Turf.js (for GeoJSON processingand geospatial calculations)
  2. Leaflet (provides OpenStreetMap widget)
  3. unmute (improved web audio behavior on iOS)