Navi

This is a tool which could easily observe and visualize each route and flow we are tracking on the real time.

There will display a tips view when your cursor is floating on a node text if you have configured the info that you want to show.

Intent

For a big App, sometime it's hard to check and debug which route we are using. what reaction will be happened once we click somewhere. in order to easily check those scenario whether or not meet the expectation, this tool is created to tackle this requirement.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequistes

What things you need to install the software and how to install them

1. Install npm

brew install node

2. Install Browsersync

npm install -g browser-sync

Integration

Implement the NaviProtocol

class Navigation: NaviProtocol {
    func rootNodeName() -> String {
        // Return root node name
        return "Navi"
    }
    
    func tabBarViewControllers() -> [String] {
        // Return tabBar controllers 
        return ["NaviDemo.FavoriteViewController", "NaviDemo.DownloadViewController", "NaviDemo.HistoryViewController"]
    }

    func mapBusinessLogicDocument() -> [String: String] {
        // Map the business logic document link to corresponding node
        return ["NaviDemo.FavoriteViewController": "https://en.wikipedia.org/wiki/Marie_Curie",
                "NaviDemo.ListViewController": "https://en.wikipedia.org/wiki/Albert_Einstein",
                "NaviDemo.DetailViewController": "https://en.wikipedia.org/wiki/Tu_Youyou",
                "NaviDemo.SettingViewController": "https://en.wikipedia.org/wiki/Alan_Turing",
                "NaviDemo.DownloadViewController": "https://en.wikipedia.org/wiki/Main_Page"]
    }
}

Note: if you are using custome Navigation, you have to implement the two optional protocols.

func currentController() -> UIViewController {
    // Return current controller
}

func previousController() -> UIViewController {
    // Return previous controller
}

Last, call the setup(with:) method and pass the instance has implemented NaviProtocol.

NaviHeader.shared.setup(with: Navigation())

Running

You have to run your project first before you execute the command below.

./run-navi.sh

TODO

• Add more cases in demo
• Support redirecting to a new page by clicking the text on a node
• Map business logic documents
• Show history paths
• Adapt mobile screen
• Monitor the network