Biao! StoryMap

Biao! is a free app to help people follow stories that highlight the locations of a series of events.

Table of Contents

• Installation
• Usage

• Floating Buttons

  • Map Type Switch
  • Map Marker Filter
  • Timeline View
  • Open Drawer Menu

• Drawer Menu

  • Map View
  • Legend View
  • About View
  • Dark Mode switch
• Other Features
• Roadmap
• Libraries
• Contributing
• License

Installation

Fork and clone the repository, then run:

# npm
npm install

Usage

For development, run:

# npm
expo start

For production, run:

# npm
expo build:android
# or
expo build:ios

Floating Buttons

The 4 floating buttons on the map screen, in clockwise from the top-left, are:

Map Type Switch

Same map types as in Google Maps:

• Roadmap view
• Satellite view
• Terrain view
• Reset map viewpoint to default

Map Marker Filter

Show / hide types of markers on map

• City Marker Filter
• Battle Marker Filter

Open Timeline Modal

• Click on a date to jump to the associated event, swipe on the date bar to jump to an earlier or later time range
• Swipe left or right on the content to view the previous or next event
• Drag the handle up / down to enter / exit full screen reading mode

Open Drawer Menu

Map View

Legend View

About View

Dark Mode switch

turn on / off dark mode

Other features

• Map marker clustering

• Landscape mode

Roadmap

• More events
• Move data to cloud
• Dynamic area coloring based on timeline
• Marching (& sailing) routes on maps
• Add tourist attractions
• More accurate area coloring for factions

Libraries

Third-party projects that helped

• expo
• redux
• @react-navigation
• react-native-maps
• react-native-modalize
• react-native-tab-view
• react-native-map-clustering
• native-base

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

GNU General Public License v3.0