maverick/flex-template-web
1
0
Fork 0
mirror of https://github.com/kingomarnajjar/flex-template-web.git synced 2026-07-26 06:47:17 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions
flex-template-web/docs
History
Hannu Lyytikainen 94658707fa Update documentation
2018-11-27 12:36:45 +02:00
..
_layouts Testing jekyll in docs folder 2018-04-19 21:29:42 +03:00
assets Update documentation 2018-11-27 12:36:45 +02:00
_config.yml Set theme jekyll-theme-minimal 2018-03-23 16:22:58 +02:00
analytics.md Format docs 2018-03-23 11:43:18 +02:00
ci.md Format markdown files 2017-12-11 11:03:08 +02:00
content-security-policy.md Remove occurrences of 'Starter App' 2018-05-04 17:04:41 +03:00
customization-checklist.md Run Prettier for docs (yarn run format-docs) 2018-09-14 15:20:54 +03:00
customization-guide.md Run Prettier 2018-11-05 12:34:31 +02:00
env.md Remove unnecessary Google Maps refs from docs and code comments 2018-09-14 16:02:37 +03:00
extend-listing.md Fix typos and broken links. 2018-05-07 11:12:50 +03:00
extended-data.md yarn run format-docs 2018-05-02 20:12:09 +03:00
folder-structure.md Remove unnecessary Google Maps refs from docs and code comments 2018-09-14 16:02:37 +03:00
google-maps.md yarn run format-docs 2018-09-26 16:46:40 +03:00
icons.md Move icons.md to correct folder 2018-05-07 13:13:59 +03:00
improving-performance.md Add a comment about the state of code-splitting 2018-10-08 16:28:21 +03:00
map-providers.md Run Prettier for docs 2018-09-14 15:21:28 +03:00
README.md Documentation for routing and loading data 2018-10-23 14:58:02 +03:00
redux.md Added doc about Redux setup 2018-10-16 12:52:13 +03:00
routing.md Documentation for routing and loading data 2018-10-23 14:58:02 +03:00
search-filters.md Update search-filters.md 2018-10-31 10:53:53 +02:00
sentry.md Remove occurrences of 'Starter App' 2018-05-04 17:04:41 +03:00
static-pages.md Remove occurrences of 'Starter App' 2018-05-04 17:04:41 +03:00
styling.md [fix] Typo fix for background-color 2018-05-21 13:31:14 +03:00
terms-of-service-and-privacy-policy.md Prefer the word customize over customise 2018-05-04 17:36:05 +03:00
testing.md Remove occurrences of 'Starter App' 2018-05-04 17:04:41 +03:00
translations.md Update documentation 2018-11-27 12:36:45 +02:00

README.md

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.

How to customize this template

The easiest way to start a customization project is to read through the customization guide. After that, you probably should start with changing translations, common styles in marketplace.css, and then create static pages and modify Terms of Service and Privacy Policy pages.

Documentation for specific topics can be found in the following files:

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.