Note: you should use Sharetribe Web Template instead when starting a new project! https://github.com/sharetribe/web-template
This is a template web application for a Sharetribe Flex marketplace ready to be extended and customized. It is based on an application bootstrapped with create-react-app with some additions, namely server side rendering and a custom CSS setup.
This template is using time-based booking process. This repository is a fork from the original FTW-daily repository (which is using nightly booking process). So, if you have started working with the original FTW repository and you want to change to FTW-hourly, you can change the 'upstream' remote repository. You can read more about time-based process from the related Flex Docs article
Note: this template assumes that you are using time-based transaction process with alias
flex-hourly-default-process/release-1, if you are using something else, you should change the alias name from config.js and util/transaction.js
If you just want to get the app running quickly to test it out, first install Node.js and Yarn, and follow along:
git clone [email protected]:sharetribe/ftw-hourly.git # clone this repository
cd ftw-hourly/ # change to the cloned directory
yarn install # install dependencies
yarn run config # add the mandatory env vars to your local config
yarn run dev # start the dev server, this will open a browser in localhost:3000You can also follow along the Getting started with FTW tutorial and read the background article about Time-based template from the Flex Docs website.
For more information of the configuration, see the FTW Environment configuration variables reference in Flex Docs.
Note: If you want to build your own Flex marketplace on top of the template, you should fork the repository instead of cloning it. See the How to Customize FTW guide in Flex Docs.
We strongly recommend installing Windows Subsystem for Linux, if you are developing on Windows. These templates are made for Unix-like web services which is the most common environment type on host-services for web apps. Also, Flex Docs uses Unix-like commands in articles instead of DOS commands.
If you want to build your own Flex marketplace by customizing the template application, see the How to Customize FTW guide in Flex Docs.
Note: Remember to fork the repository before deploying the application. Connecting your own Github repository to Heroku will make manual deploys easier.
See the How to deploy FTW to production guide in Flex Docs for more information.
See the Flex Docs site: https://www.sharetribe.com/docs/
See also the docs/ directory for some additional internal documentation.
If you have any questions about development, the best place to ask them is the Flex Developer Slack channel at https://www.sharetribe.com/flex-slack
This project is licensed under the terms of the Apache-2.0 license.
See LICENSE