Skip to content

sdsquire/FamilyMapClient

Repository files navigation

FamilyMap Client

Family Map is an Android application that provides a geographical view into your family history. By inputting your family tree, you can explore where each member of your family was born, married, died, and other major life events on an interactive map.

Demo of the FamilyMap App

This repository contains the Android client code, which communicates with a backend server to manage user information and family history data. The backend server is available in the FamilyMapServer repository.

Features

  • User login and registration

The Login Page

- World map showing family events

Demo of the FamilyMap App

- Selecting pins to trace the family member's life path

Demonstrates the Life Line Feature

- Filtering and searching family history data

Searching a Person

- Settings customization

The Settings section

Getting Started

Prerequisites

Installation

  1. Clone the Repository:

    git clone https://github.com/yourusername/family-map-client.git
    cd family-map-client
  2. Open in Android Studio:

    Open Android Studio and select Open an existing Android Studio project. Navigate to the family-map-client directory and open it.

  3. Build and Run the App:

    Connect an Android device or start an emulator. In Android Studio, click on Run -> Run 'app' to install and run the app on your device/emulator.

Usage

  1. Set Server Endpoint:

    On the Login screen, enter the server hostname/IP address and port number where the FamilyMap Server is running.

  2. Login or Register:

    • Login: Enter your username and password, then click "SIGN IN".
    • Register: Fill in all the fields and click "REGISTER".
  3. Explore the Map:

    • View family events on the map.
    • Click markers to see event details.
    • Use the options menu to filter events, change settings, or search for specific events and people.

Key Activities

  • Main Activity: Login and top-level map view.
  • Person Activity: View details about a person and their relationships.
  • Map Activity: Centered map view on a specific event.
  • Settings Activity: Customize settings, re-sync data, log out.
  • Filter Activity: Apply filters to the displayed events.
  • Search Activity: Search for people and events.

License

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

Additional Resources

For more information, visit the FamilyMapServer repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages