1.0.2 • Published 11 months ago

@ruttl/bug-tracking v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

Introduction

Welcome to the official Bug Tracking React Native component provided by ruttl. The Bug Tracking React Native component is an open-source project, and we'd love to see your contributions!

Quick Start Guide

Ruttl's Bug Tracking React Native component is a re-usable component built around ruttl’s bug tracking ecosystem. Check out our official website for more in depth information.

Step 1: Installation

Under your app's root directory, run

npm install @ruttl/bug-tracking

Step 2: Add to any component

Following code snippet shows how you can use our SDK with an existing component in your current app

import React from 'react';
import { SafeAreaView, View } from 'react-native';
import BugTracking from '@ruttl/bug-tracking';

const ExistingComponent = () => {
    return (
        <SafeAreaView>
        <View />
        <BugTracking
            projectID="..."
            token="..."
        />
        </SafeAreaView>
    );
}

export default ExistingComponent;

Step 3: How to use

Once the setup is complete, please click on the floating bug icon, touch & encircle to annotate bugs, enter the description & add a ticket. You can change the highlight colour, if needed.

Props

NameDescriptionTypeRequired
projectIDID of the ruttl projectstringyes
tokenAuthentication token generated by the serverstringyes