Skip to content

masim5722/tourguide

Repository files navigation

tourguide

Tour Guide is a private react library which is used to implement web tour in to the application

NPM JavaScript Style Guide

Install

npm install --save @masim5722/tourguide

Usage

import React from 'react'

import 'tourguide/dist/index.css'
import TourGuide from 'tourguide'
import config from './config'


const App = () => {
  return <TourGuide page="demo"
                    base_api_url={config.base_api_url}
                    api_secret={config.api_secret}
                    system={3}
                    employeeId="0"
                    startbutton={true}
                    endbutton={true}
  />
}

export default App

config.js

Create config.js file in components folder.

/**
 * Configuration file for TourGuide Library
 * @type {string}
 */

// base api url
const base_api_url = <BASE API URL>;
const api_secret = <API SECRET>;
const system_id = <SYSTEM ID>;

let config = {
    "base_api_url":base_api_url,
    "api_secret":api_secret,
    "system_id": system_id
};

export default config;

License

MIT © masim5722

About

React Tour Guide

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published