maverick/flex-template-web
1
0
Fork 0
mirror of https://github.com/kingomarnajjar/flex-template-web.git synced 2026-07-28 12:43:11 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #911 from sharetribe/doc-improvements

Browse source 
Documentation improvements
This commit is contained in:
Vesa Luusua 2018-09-05 17:24:31 +03:00 • committed by GitHub
commit b76a9ef015
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -12,6 +12,8 @@ way to update this template, but currently, we follow a pattern:
---
## Upcoming version 2018-09-XX
* [change] Update git links and improve documentation
[#911](https://github.com/sharetribe/flex-template-web/pull/911)
* [change] improve env-template to better defaults.
[#912](https://github.com/sharetribe/flex-template-web/pull/912)
* [fix] Touch event from location autocomplete prediction list ended up causing clicks.

4
README.md
View file

@ -13,8 +13,8 @@ If you just want to get the app running quickly to test it out, first install
[Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/), and follow along:
```sh
git clone git@github.com:sharetribe/sharetribe-starter-app.git # clone this repository
cd sharetribe-starter-app/ # change to the cloned directory
git clone git@github.com:sharetribe/flex-template-web.git # clone this repository
cd flex-template-web/ # change to the cloned directory
cp .env-template .env # copy the env template file to add your local config
emacs .env # in your favorite editor, add the mandatory env vars to the config
yarn install # install dependencies

2
docs/customization-guide.md
View file

@ -48,7 +48,7 @@ In the directory you want to create the project in:
git clone git@github.com:YOUR_USERNAME/YOUR_FORK.git # clone your fork
cd YOUR_FORK # changed to the cloned directory
git remote add upstream git@github.com:sharetribe/sharetribe-starter-app.git # add the template as the upstream remote
git remote add upstream git@github.com:sharetribe/flex-template-web.git # add the template as the upstream remote
See also the
[Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)

3
docs/search-filters.md
View file

@ -37,6 +37,9 @@ _capacity_ attribute the parameter would be "pub_capacity".
Further reading on public data can be found in the
[extended data documentation](./extended-data.md).
**NOTE:** Please contact the Sharetribe support in order to update your listing index schema when
planning to use new listing fields as search filters.
### Common changes
A few common changes are required to add a select single or a select multiple filter to desktop and