f36bc32694
- customization checklist - styling - icons - translations - tos and privacy policy - static pages
4.5 KiB
Flex Template for Web: Documentation
Why Saunatime?
Short answer: Demonstrate the features of Flex with a marketplace for renting saunas. Because why not.
Long answer: Saunatime works as a template for a marketplace user interface. It can be used as a marketplace client out of the box but is intended to be modified to match the requirements of each marketplace built on top of the Flex API. Also, marketplaces that do not use Saunatime as a template for building a client can use this template application as a reference on how the Flex API can be used in a browser environment using the JavaScript SDK.
Marketplace features included in Saunatime:
- Location search shows the user if there are saunas available in a given location.
- The listing page gives a detailed view about what a particular sauna offers.
- Transaction process: Saunatime uses nightly booking.
- Notifications: Emails are sent during the booking process to alert customers and providers about changes in the booking state.
- Inbox lists orders and sales.
- Reviews can be given after a completed transaction.
- User profiles provide detailed information about a given user.
- Extended data: The listing and user data models are modified using extended data.
Flex Docs website
We are currently moving documentation to the Flex Docs site, so at the moment part of the documentation is in this repository and part is in the Flex Docs site.
See the Flex Docs site: https://www.sharetribe.com/docs/
Getting started
We recommend going through the Getting started articles in the Flex Docs:
Customization guide
The easiest way to start a customization project is to read through the How to Customize FTW guide in Flex Docs.
How to customize this template
After going through the customization guide, you should probably start with the following guides in Flex Docs:
- How to set up Mapbox for FTW
- How to change FTW UI texts and translations
- How to customize FTW styles
- How to change Terms of Service and Privacy Policy in FTW
- How to change FTW icons
- FTW customization checklist
See also the following articles:
- How to add static pages in FTW
- How to test FTW
- How to set up Sentry to log errors in FTW
- How to set up Analytics for FTW
- How to set up Content Security Policy (CSP) for FTW
Extra documentation for specific topics can be found in the following files:
- Folder structure
- Routing
- Redux and duck files
- Extended data
- See also the Extended data reference in Flex Docs
- Extend the listing data model
- Search filters
- Continuous Integration (CI)
- Improving performance
- Deploying to production
- Original create-react-app documentation
The application was bootstrapped with a forked version of create-react-app. While most of the original documentation still applies, there are some important differences listed in the sharetribe-scripts NPM package.