Skip to content

Latest commit

 

History

History
186 lines (135 loc) · 5.85 KB

README.md

File metadata and controls

186 lines (135 loc) · 5.85 KB
Raw

Contributors Stargazers Issues


Logo

Tradly Platform

An open source React Native Template. Built on top of Tradly Headless API
Explore the docs »

View Demo · Report Bug · Request Feature

Contributors Stargazers Issues

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

This React Native template provides a basic to intermediate mobility based project. With a few smaller customisation on strings used in the app, it can be personalised for other marketplace types as well. Progressively we will be adding the mobile app configs that will help you to customise things from Tradly SuperAdmin

Current Use cases we have in mind

  • Recycle Management App
  • Geo directory based Apps

The short video could explain the feature sets we have. Just ping us in community forum if you would like to have the Figma file

App Features youtube link

Features

PENDING TO BE ADDED HERE THE LIST

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

We recommend installing Node and Watchman using Homebrew. Run the following commands in a Terminal after installing Homebrew:

  • Node 
    brew install node
brew install watchman

Installation

  1. Clone the repo 
    git clone https://github.com/TRADLY-PLATFORM/Penguin.git
  2. Install NPM packages 
    npm install

iOS

In the `ios` directory
* Install Pods: `gem install cocoapods`
* Install Pods: `pod install`

Android

  • You might need to do this to run it in Android Studio or on real device: adb reverse tcp:8081 tcp:8081
  • And for the sample server: adb reverse tcp:3000 tcp:3000
  • To run from command line try: react-native run-android

Usage

Here is some client/app specific things you might need to change. 3rd party integrations with Stripe, Firebase, Sentry need your own account Keys for it to work.

  • TenantID of Tradly can be found from Tradly Superadmin Dashboard(Sandbox or Production tenantID/APIkey based on your purchase)
  • You might be change these values which are given below
// AppConstant.js

    appSharePath: 'abc://',
    stripePublishKey: 'abc',
    dsnSentry: 'https://abc.ingest.sentry.io/5896058',
    firebaseChatPath: '/abc_dev/',
    tenantID:'abc',

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.