Skip to content

BuildFire/locationsPlugin

Repository files navigation

Locations

Overview

Empower your app with the "Locations" plugin, offering powerful location-based capabilities. This plugin allows users to discover, explore, and connect with various places effortlessly. With features like location management and a sophisticated algorithm to list locations based on user proximity, it enhances the user experience by integrating geographical context.

Features

  • Location Management: Create, edit, and delete location entries seamlessly.
  • Proximity-Based Listing: Utilizes a complex algorithm considering the user's position to fetch and sort locations by distance.
  • Interactive Map Screen: A comprehensive map view powered by Google Maps to visualize locations.
  • Swipeable Drawer: Easily navigate through a list of locations.
  • Detailed Location Pages: Access individual details for each location.
  • Introduction Screen: A user-friendly introductory screen, fully configurable.

Prerequisites

  • Node.js installed on your development machine.
  • A Google Maps API Key for map functionality.

Installation

Step 1: Clone/Download

git clone [email protected]:BuildFire/locationsPlugin.git

Step 2: Install Dependencies

npm install

Step 3: Development Mode

To run the plugin in development mode, use the following command:

npm start

Step 4: Production Build

For production bundling, run:

npm run build

Configuring Google Maps API Key

To integrate Google Maps in the plugin, you need to provide a valid API key. Follow these steps:

  • Obtain a Google Maps API Key from the Google Cloud Platform.
  • Add the API key to the API Keys.

Usage

After installation and setup, you can start the plugin through BuildFire Plugin Tester. Ensure that you have configured the Google Maps API Key to utilize the full range of mapping features.