DeepTrekker React SDK

Overview

This SDK enables developers to rapidly build Deep Trekker front-end applications. It is comprised of a set of reusable react components based on our custom design system which can be themed and tailored to your needs.

Pre-requisites

To begin using this SDK, we require that you set up a compatible TypesScript/JavaScript project with the following dependencies installed and configured:

1. React (17+) — This is a framework for rapidly building user interfaces and is the basis for this SDK.

2. TailwindCSS — This facilitates custom theming, extensibility, and not to mention, it comes jam packed with a comprehensive set of utility classes that greatly compliments component-driven UI development.

   We use this as the basis for styling our components and leave this as a decoupled installation in order to take advantage of optionally theming our components. We encourage the use of tailwind in your project, but you are not tied to using it beyond the initial configuration.

📦 Installation

1. Open your project

2. Run

   npm install @deeptrekker/react-sdk

3. Add a tailwind.config.js file. Add the following plugin to enable our default DeepTrekker theme:

(Internal)

Usage

1. Open the file with the react root.

2. Import the stylesheet.

   // app.tsx
   import "@deeptrekker/react-sdk/dist/index.css";

3. Use the components. For example:

   // YourComponent.jsx
   ...
   import { Button as DeepTrekkerButton } from "@deeptrekker/react-sdk";
   ...

Customization

Theming