Sharetribe Web Template

This is a template web application for a Sharetribe Flex marketplaces. You could create your own unique marketplace web app by cloning this repository and then extending and customizing it to your needs. This template is bootstrapped with create-react-app with some additions, namely server side rendering, code-splitting, and a custom CSS setup.

Note: You should start your customization project on top of this one instead of the old templates:

FTW-daily

FTW-hourly

FTW-product

Read more from Flex Docs preview version

Note: The search does not work on the preview version of the Flex Docs. It links to live documentation.

Quick start

Setup localhost

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 git@github.com:sharetribe/web-template.git  # clone this repository
cd web-template/                                      # 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 Sharetribe Web Template tutorial in the Flex Docs website.

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

For Windows users

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.

Getting started with your own customization

If you want to build your own Flex marketplace by customizing the template application, see the How to Customize the Template guide in Flex Docs.

Deploying to Heroku

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 this template to production guide in Flex Docs for more information.

Documentation

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

Note: The search does not work on the preview version of the Flex Docs. It links to live documentation.

Get help – join Sharetribe Flex Developer Slack channel

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

License

This project is licensed under the terms of the Apache-2.0 license.

See LICENSE

EugeneLoy/web-template