Note If you are using day-based booking process (i.e. daily or nightly bookings), you should choose the original Flex Template for Web instead.
This is a beta version of the template web application for a Sharetribe Flex marketplace using time-based booking process. Many things in the template, from things like default content pages and marketplace colors and styling, are likely to change in the coming weeks. Also, adding, removing or viewing availability exceptions as a provider is not yet supported. This support will be added later.
This repository is a fork from the existing FTW 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-time, you can change the 'upstream' remote repository.
Note: we have created another template for time-based processes. It is still in beta mode, but if you are taking time-based booking process into use, you should consider using it instead. You can read more from the related Flex Docs article
Note: this template assumes that you are using time-based transaction process with alias
preauth-unit-time-booking/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-time.git # clone this repository
cd flex-template-web/ # 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:3000
You 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.
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