https://github.com/tradly-platform/hummingbirds
Hummingbirds - A reactJs based modular commerce web app build on top of Tradly Headless API. It is community open-source edition that allow you or your clients to launch web apps. More than a starter kit, have more than 60% of what is available in the native app. You need a tenantID to run the app, signup for a freesandbox account at Tradly.app or use tradlysocial to test the app
https://github.com/tradly-platform/hummingbirds
ecommerce-store headless marketplace reactjs reactjs-boilerplate storefront
Last synced: about 2 months ago
JSON representation
Hummingbirds - A reactJs based modular commerce web app build on top of Tradly Headless API. It is community open-source edition that allow you or your clients to launch web apps. More than a starter kit, have more than 60% of what is available in the native app. You need a tenantID to run the app, signup for a freesandbox account at Tradly.app or use tradlysocial to test the app
- Host: GitHub
- URL: https://github.com/tradly-platform/hummingbirds
- Owner: TRADLY-PLATFORM
- Created: 2020-04-08T13:00:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T06:22:36.000Z (over 2 years ago)
- Last Synced: 2024-04-08T09:09:34.658Z (over 1 year ago)
- Topics: ecommerce-store, headless, marketplace, reactjs, reactjs-boilerplate, storefront
- Language: JavaScript
- Homepage: https://tradly.app
- Size: 10.3 MB
- Stars: 12
- Watchers: 4
- Forks: 8
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
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
## 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](https://reactjs.org/)
* [Bootstrap3](https://getbootstrap.com/)
* [Tradly Headless API](https://tradly.app)
## Deploy on Vercel, Netlify
[](https://vercel.com/new/clone?repository-url=https://github.com/TRADLY-PLATFORM/Hummingbirds)
[
](https://app.netlify.com/start/deploy?repository=https://github.com/TRADLY-PLATFORM/Hummingbirds)
## 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
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/TRADLY-PLATFORM/Hummingbirds.git
```
2. Install NPM packages
```sh
npm install
```
## Deploy in Netlify
[](https://youtu.be/ALQwwL4U-AU "Launching 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](https://superadmin.sandbox.tradly.app), 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.
```tsx
// constants.js
dsn: 'https://abc.ingest.sentry.io/5896058',
```
## Roadmap
See the [open issues](https://github.com/github_username/repo_name/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 - hitradly@gmail.com
Project Link: [https://github.com/github_username/repo_name](https://github.com/TRADLY-PLATFORM/Hummingbirds)
[contributors-shield]: https://img.shields.io/github/contributors/TRADLY-PLATFORM/Hummingbirds
[contributors-url]: https://github.com/TRADLY-PLATFORM/Hummingbirds/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/TRADLY-PLATFORM/Hummingbirdse
[forks-url]: https://github.com/TRADLY-PLATFORM/Hummingbirds/network/members
[stars-shield]: https://img.shields.io/github/stars/TRADLY-PLATFORM/Hummingbirds
[stars-url]: https://github.com/TRADLY-PLATFORM/Hummingbirds/stargazers
[issues-shield]: https://img.shields.io/github/issues/TRADLY-PLATFORM/Hummingbirds
[issues-url]: https://github.com/TRADLY-PLATFORM/Hummingbirds/issues
[license-shield]: https://img.shields.io/github/license/TRADLY-PLATFORM/repo.svg?style=for-the-badge
[license-url]: https://github.com/TRADLY-PLATFORM/Hummingbirds/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/github_username