leumas-react-traffic-data/README.md

This is ot easily embed a component on any of your React pages, and have us track their usage for you to view in Leumas Portal. Must have a Leumas Pro Membership and Api Key prior to usage on this NPM Package. Please refer to leumas react traffic data doc

# Leumas React Traffic Data


### Grab an API Key from apikeys.leumas.tech

You must have a Leumas account, and a Leumas PRO membership to receive an API Key

Signup at https://leumas.tech/signup

Purchase your membership: 19.00 m/o
https://leumas.tech/membership-account/membership-levels/


Login to Leumas API Portal https://apikeys.leumas.tech/login

Generate your API key, it will be saved so dont worry 


### install in your React Project
```bash
npm i leumas-react-traffic-data
```

**Import Code**
- You can drop this on any page or any component to Track Its usage with our database


### Reccomended Setup

**Add API Key to Environment Variables**:
- Create a .env file (if not already present) in the root of your project and add your API key:

```env
VITE_REACT_APP_TRAFFIC_DATA_API_KEY=your_api_key_here
```

### Import and Use the TrafficData Component:
```jsx
function App () => {
    return(
        <div>
            <TrafficData
                pageName=""
                apiKey={`${import.meta.env.VITE_REACT_APP_TRAFFIC_DATA_API_KEY}`}
            />
        </div>
    )
}
```


### Track Your Usage
Everytime a person visits your store we will update your page views, Let you know their device viewing on, their IP, Number of total page views, and potentially more in the future.

To visit your dashboard and track your usage, please use our API or our Dashboard. Note that the dashboard feature is not yet implemented.