/mapStory

Primary LanguageTypeScript


Logo

Trip Advice

Table of Contents
  1. About The Project

  2. Getting Started

About The Project


Mock Prep Banner

This application allows user to view their trips on a map, & also view details related to each trip and destination.

Artefacts


Wireframes     
Coding Practices

Features:

  1. Intial Render to default coordinations
    • The initial map will be render with preset coordinates display zoomed out map view of US, this is done to keep a defalt map view in place

  2. Select Trip & Fly
    • We have provided a one-click option that will take you to your desired trip on the map, along with relevant notes and timelines from your travel history.

  3. Dynamic Search for best experience
    • Search for trips using the dynamic search feature, which filters out trips based on names that match, as well as error bounds.

  4. Filter Trips by travel type
    • Filter trips by travel type using quick filter option, while handling errors for any missing data validations.
    • The data for filter was dynamically imported from a json file.

  5. Sorting by name and date
    • To find trips that suit your needs, sort your travels by name of date in ascending or descending order.
    • The data for sort was dynamically imported from a json file,and not hardcoded.

  6. Dynamic Icon & zoom outs
    • The specific list will be highlighted if you click on the map icon; there are also back and front buttons, as well as zoom out.

  7. Additional features for dynamic trip count & date calculation
    • We have gone one step ahead in representing the details in best way possible.
    • The trip count indicator represents count of trips displayed & trip start and end date displayed are calculated dynamically using momentjs

Tech Stack



Getting Started

Following are the simple steps to run this project.


Prerequisites


Install Node

Install git

Installation

  1. Clone the repo

    git clone https://github.com/sraghudatta94/mapStory.git
  2. Install NPM packages

    cd mapstory && npm install
  3. Run

    npm start
  4. Open

     http://localhost:3000 to view it in the browser
  5. Run Test cases

     npm test
  6. Run Story book

    yarn storybook



Other Available Scripts

Unit Testing

We are testing our application with edge cases using jest and react testing library.

Story Book


Tools and Libraries

  • [MapBox-GL] - Map Configuration
  • [Ant-Design] - Styled components
  • [typescript] - Static type checking
  • [Moment-js] - Dates
  • [Eslint] - Error check
  • [Story-Book] - Component library


Mobile Responsive

  • Fits to Mobile Screen
  • Fits to Tab Screen
  • Fits to Desktop