Sharetribe Flex Template Demo

by shrinedev

GitHub Readme.md

Sharetribe Flex Template for Web

CircleCI

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.

Quick start

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 [repo-url]                                           # clone this repository
cd rather-rent-ftw/                                            # 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 in the Flex Docs website.

For more information of the configuration, see the FTW Environment configuration variables reference in Flex Docs.

Customizing

See the How to Customize FTW guide in Flex Docs.

Deploying to Heroku

Every push to master is automatically deployed to the heroku site

Documentation

See the Flex Docs site: https://www.sharetribe.com/docs/

See also the docs/ directory for some additional internal documentation.