Tradly Platform

An open source ReactJS Template. Contents served from Tradly Headless API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This is an open source business web site. Which you can easily use for your business platform by changing a little bit.It has all the features of a business website. The benefits of SEO have also been added. Which is Google friendly. And you can easily optimize your website.

The preview of the project.

Built With

• React
• Bootstrap3
• Tradly Headless API

Deploy on Vercel, Netlify

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/TRADLY-PLATFORM/Hummingbirds.git

2. Install NPM packages

   npm install

Deploy in Netlify

Usage

There are some things you need to know to work on this open source. There are three environment files that can be run and built separately.

1. Change "REACT_APP_DOMAIN_URL" from environment files and add your website url there.This is for SEO purpose. If you don't change this variable then you face many problems in SEO.
2. Once you sign up with Tradly Sandbox, you can get your API key (It is public key).After that you create a variable in your environment files called "REACT_APP_API_KEY" And put the API key here.
3. Here is some client/web specific things you might need to change. 3rd party integrations with Stripe, Firebase, Sentry need your own account Keys for it to work.

// constants.js

    dsn: 'https://abc.ingest.sentry.io/5896058',

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Tradly Platform - [email protected]

Project Link: https://github.com/github_username/repo_name