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
Mirror of github.com/kingomarnajjar/flex-template-web
4296 commits 6 branches 51 tags 20 MiB
Find a file
Jenni Nurmi 01c2bcfab7 Edit changelog
2019-01-22 15:38:32 +02:00
.circleci Temporarily remove audit from CircleCI 2018-12-17 13:29:23 +02:00
docs Update documentation 2019-01-22 10:57:49 +02:00
ext/default-mail-templates Run Prettier for docs 2018-12-20 16:09:50 +02:00
public Update Mapbox SDK 2019-01-17 15:29:46 +02:00
scripts Edit docs and add comments to code 2019-01-17 12:44:00 +02:00
server Update Sentry DSN related env variables and docs 2019-01-17 10:29:39 +02:00
src Add link to additional owner info text 2019-01-22 15:35:54 +02:00
.editorconfig Add .editorconfig file and make Prettier use it 2017-12-11 11:27:24 +02:00
.env-template Edit environment variables after .env file is created 2019-01-17 12:44:00 +02:00
.env.development Use Transit Verbose mode in development 2018-04-12 16:28:16 +03:00
.env.test Revert PORT handling to previous behaviour 2018-03-15 22:25:47 +02:00
.gitignore Harmonize client & server env handling 2018-03-15 14:27:57 +02:00
.nsprc Create-react-app has dependency to vulnerable lib - we need to wait them to react. 2018-08-03 14:31:48 +03:00
.prettierignore Add components and containers index-files to .prettierignore 2018-11-15 15:16:04 +02:00
app.json Create app.json 2018-11-30 09:34:21 +02:00
CHANGELOG.md Edit changelog 2019-01-22 15:38:32 +02:00
LICENSE Add Apache-2.0 license 2018-01-08 10:43:58 +02:00
package.json update package.json 2019-01-17 13:29:38 +02:00
README.md Edit docs and add comments to code 2019-01-17 12:44:00 +02:00
yarn.lock Use new Sentry SDKs insted of Raven 2019-01-17 10:29:33 +02:00

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 git@github.com:sharetribe/flex-template-web.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

See the Environment configuration variables documentation for more information of the required configuration variables.

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 Customization guide.

Getting started with your own customization

If you want to build your own Flex marketplace by customizing the template application, see the Customization guide documentation.

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 documentation about deploying to Heroku for more information.

Deploy

Documentation

Full documentation can be found in the docs directory.

License

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

See LICENSE