mirror of
https://github.com/kingomarnajjar/flex-template-web.git
synced 2026-07-26 06:47:17 +10:00
Re-run Prettier with updated dependencies
This commit is contained in:
Kimmo Puputti
parent
87d488d8b6
commit
53f8bb3f6f
5 changed files with 93 additions and 93 deletions
|
|
@ -13,15 +13,15 @@ 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
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
## Flex Docs website
|
||||
|
||||
|
|
@ -36,9 +36,9 @@ We recommend going through the
|
|||
[Getting started articles](https://www.sharetribe.com/docs/background/getting-started/) in the Flex
|
||||
Docs:
|
||||
|
||||
* [Introducing Flex](https://www.sharetribe.com/docs/background/introducing-flex/)
|
||||
* [What development skills are needed?](https://www.sharetribe.com/docs/background/development-skills/)
|
||||
* [Getting started with FTW](https://www.sharetribe.com/docs/tutorials/getting-started-with-ftw/)
|
||||
- [Introducing Flex](https://www.sharetribe.com/docs/background/introducing-flex/)
|
||||
- [What development skills are needed?](https://www.sharetribe.com/docs/background/development-skills/)
|
||||
- [Getting started with FTW](https://www.sharetribe.com/docs/tutorials/getting-started-with-ftw/)
|
||||
tutorial.
|
||||
|
||||
## How to customize this template
|
||||
|
|
@ -51,34 +51,34 @@ The easiest way to start a customization project is to read through the
|
|||
|
||||
Documentation for specific topics can be found in the following files:
|
||||
|
||||
* [Customization guide](customization-guide.md)
|
||||
* [Folder structure](folder-structure.md)
|
||||
* [Translations](translations.md)
|
||||
* [Styling a marketplace](styling.md)
|
||||
* [Static pages](static-pages.md)
|
||||
* [Terms of Service and Privacy Policy](terms-of-service-and-privacy-policy.md)
|
||||
* [Routing](routing.md)
|
||||
* [Redux and duck files](redux.md)
|
||||
* [Extended data](extended-data.md)
|
||||
* See also the
|
||||
- [Customization guide](customization-guide.md)
|
||||
- [Folder structure](folder-structure.md)
|
||||
- [Translations](translations.md)
|
||||
- [Styling a marketplace](styling.md)
|
||||
- [Static pages](static-pages.md)
|
||||
- [Terms of Service and Privacy Policy](terms-of-service-and-privacy-policy.md)
|
||||
- [Routing](routing.md)
|
||||
- [Redux and duck files](redux.md)
|
||||
- [Extended data](extended-data.md)
|
||||
- See also the
|
||||
[Extended data reference](https://www.sharetribe.com/docs/references/extended-data/) in Flex
|
||||
Docs
|
||||
* [Extend the listing data model](extend-listing.md)
|
||||
* [Search filters](search-filters.md)
|
||||
* [Testing](testing.md)
|
||||
* [Continuous Integration (CI)](ci.md)
|
||||
* [Original create-react-app documentation](https://github.com/sharetribe/create-react-app/blob/master/packages/react-scripts/template/README.md)
|
||||
* [Customization checklist](customization-checklist.md)
|
||||
* [Icons](icons.md)
|
||||
* [Improving performance](improving-performance.md)
|
||||
* [Deploying to production](deploying-to-production.md)
|
||||
- [Extend the listing data model](extend-listing.md)
|
||||
- [Search filters](search-filters.md)
|
||||
- [Testing](testing.md)
|
||||
- [Continuous Integration (CI)](ci.md)
|
||||
- [Original create-react-app documentation](https://github.com/sharetribe/create-react-app/blob/master/packages/react-scripts/template/README.md)
|
||||
- [Customization checklist](customization-checklist.md)
|
||||
- [Icons](icons.md)
|
||||
- [Improving performance](improving-performance.md)
|
||||
- [Deploying to production](deploying-to-production.md)
|
||||
|
||||
See also the following articles in the [Flex Docs](https://www.sharetribe.com/docs/) website:
|
||||
|
||||
* [How to set up Mapbox for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-mapbox-for-ftw/)
|
||||
* [How to set up Sentry to log errors in FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-sentry-to-log-errors-in-ftw/)
|
||||
* [How to set up Analytics for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-analytics-for-ftw/)
|
||||
* [How to set up Content Security Policy (CSP) for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-csp-for-ftw/)
|
||||
- [How to set up Mapbox for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-mapbox-for-ftw/)
|
||||
- [How to set up Sentry to log errors in FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-sentry-to-log-errors-in-ftw/)
|
||||
- [How to set up Analytics for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-analytics-for-ftw/)
|
||||
- [How to set up Content Security Policy (CSP) for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-csp-for-ftw/)
|
||||
|
||||
The application was bootstrapped with a forked version of
|
||||
[create-react-app](https://github.com/facebookincubator/create-react-app). While most of the
|
||||
|
|
|
|||
|
|
@ -2,42 +2,42 @@
|
|||
|
||||
Some generic things to update and check when starting to customize the template.
|
||||
|
||||
* [Marketplace colors](styling.md)
|
||||
* [Generate app icons](icons.md)
|
||||
* [Update translations](../src/translations/en.json) or [change the language](translations.md)
|
||||
* [LandingPage](../src/containers/LandingPage/LandingPage.js): update and create branded sections
|
||||
* [Footer](../src/components/Footer/Footer.js)
|
||||
* [AboutPage](../src/containers/AboutPage/AboutPage.js)
|
||||
* [Terms of Service](terms-of-service-and-privacy-policy.md#terms-of-service)
|
||||
* [Privacy Policy](terms-of-service-and-privacy-policy.md#privacy-policy)
|
||||
* [Social media sharing graphics](../src/components/Page/Page.js);
|
||||
* [Logo](../src/components/Logo/Logo.js) Change and check that it works on Topbar, Footer, and
|
||||
- [Marketplace colors](styling.md)
|
||||
- [Generate app icons](icons.md)
|
||||
- [Update translations](../src/translations/en.json) or [change the language](translations.md)
|
||||
- [LandingPage](../src/containers/LandingPage/LandingPage.js): update and create branded sections
|
||||
- [Footer](../src/components/Footer/Footer.js)
|
||||
- [AboutPage](../src/containers/AboutPage/AboutPage.js)
|
||||
- [Terms of Service](terms-of-service-and-privacy-policy.md#terms-of-service)
|
||||
- [Privacy Policy](terms-of-service-and-privacy-policy.md#privacy-policy)
|
||||
- [Social media sharing graphics](../src/components/Page/Page.js);
|
||||
- [Logo](../src/components/Logo/Logo.js) Change and check that it works on Topbar, Footer, and
|
||||
CheckoutPage
|
||||
* [Default background image](../src/assets/background-1440.jpg)
|
||||
* [Maps Marker icon](../src/components/Map/images/marker-32x32.png)
|
||||
* [Config: update environment variables](../src/config.js)
|
||||
* [Config: siteTitle](../src/config.js) for page schema (SEO)
|
||||
* [Config: marketplace address](../src/config.js): contact details also improve SEO
|
||||
* [Config: social media pages](../src/config.js)
|
||||
* [Marketplace custom config](../src/marketplace-custom-config.js)
|
||||
* Update [ListingPage](../src/containers/ListingPage/ListingPage.js) to show extended data (aka
|
||||
- [Default background image](../src/assets/background-1440.jpg)
|
||||
- [Maps Marker icon](../src/components/Map/images/marker-32x32.png)
|
||||
- [Config: update environment variables](../src/config.js)
|
||||
- [Config: siteTitle](../src/config.js) for page schema (SEO)
|
||||
- [Config: marketplace address](../src/config.js): contact details also improve SEO
|
||||
- [Config: social media pages](../src/config.js)
|
||||
- [Marketplace custom config](../src/marketplace-custom-config.js)
|
||||
- Update [ListingPage](../src/containers/ListingPage/ListingPage.js) to show extended data (aka
|
||||
publicData attribute)
|
||||
* Update [EditListingWizard](../src/components/EditListingWizard/EditListingWizard.js) and panels to
|
||||
- Update [EditListingWizard](../src/components/EditListingWizard/EditListingWizard.js) and panels to
|
||||
add extended data
|
||||
* Update [SearchPage](../src/containers/SearchPage/SearchPage.js) to filter with extended data
|
||||
* Update [routeConfiguration](../src/routeConfiguration.js) if needed
|
||||
* Update [Email templates](../ext/default-mail-templates), all of them: .html, subject.txt, and
|
||||
- Update [SearchPage](../src/containers/SearchPage/SearchPage.js) to filter with extended data
|
||||
- Update [routeConfiguration](../src/routeConfiguration.js) if needed
|
||||
- Update [Email templates](../ext/default-mail-templates), all of them: .html, subject.txt, and
|
||||
text.txt
|
||||
* See the [Email template reference](https://www.sharetribe.com/docs/references/email-templates/)
|
||||
- See the [Email template reference](https://www.sharetribe.com/docs/references/email-templates/)
|
||||
in Flex Docs for more information.
|
||||
* Update [config: bookingUnitType](../src/config.js) if needed
|
||||
* If `line-item/units` is used, add quantity handling to
|
||||
- Update [config: bookingUnitType](../src/config.js) if needed
|
||||
- If `line-item/units` is used, add quantity handling to
|
||||
[BookingDatesForm](../src/forms/BookingDatesForm/BookingDatesForm.js),
|
||||
[ListingPage](../src/containers/ListingPage/ListingPage.js),
|
||||
[CheckoutPage](../src/containers/CheckoutPage/CheckoutPage.js)
|
||||
|
||||
## What else
|
||||
|
||||
* Do you need more [static pages](static-pages.md)?
|
||||
* Changes to existing pages
|
||||
* Changes to transaction process (API + Web app)
|
||||
- Do you need more [static pages](static-pages.md)?
|
||||
- Changes to existing pages
|
||||
- Changes to transaction process (API + Web app)
|
||||
|
|
|
|||
|
|
@ -13,17 +13,17 @@ We recommend going through the
|
|||
[Getting started articles](https://www.sharetribe.com/docs/background/getting-started/) in the Flex
|
||||
Docs:
|
||||
|
||||
* [Introducing Flex](https://www.sharetribe.com/docs/background/introducing-flex/)
|
||||
* [What development skills are needed?](https://www.sharetribe.com/docs/background/development-skills/)
|
||||
* [Getting started with FTW](https://www.sharetribe.com/docs/tutorials/getting-started-with-ftw/)
|
||||
- [Introducing Flex](https://www.sharetribe.com/docs/background/introducing-flex/)
|
||||
- [What development skills are needed?](https://www.sharetribe.com/docs/background/development-skills/)
|
||||
- [Getting started with FTW](https://www.sharetribe.com/docs/tutorials/getting-started-with-ftw/)
|
||||
tutorial.
|
||||
|
||||
## Requirements
|
||||
|
||||
Install required tools:
|
||||
|
||||
* [Node.js](https://nodejs.org/)
|
||||
* [Yarn](https://yarnpkg.com/)
|
||||
- [Node.js](https://nodejs.org/)
|
||||
- [Yarn](https://yarnpkg.com/)
|
||||
|
||||
## Technologies
|
||||
|
||||
|
|
@ -35,13 +35,13 @@ get-go.
|
|||
|
||||
Here are some main technologies that the template uses:
|
||||
|
||||
* JavaScript: programming language for the whole application
|
||||
* CSS: styling the user interface using [CSS Modules](https://github.com/css-modules/css-modules)
|
||||
* [React](https://reactjs.org/): library for creating user interfaces with components
|
||||
* [Redux](https://redux.js.org/): state and data flow handling
|
||||
* [Final Form](https://github.com/final-form/final-form): forms
|
||||
* [React Router](https://reacttraining.com/react-router/): routing
|
||||
* [Express](https://expressjs.com/): server
|
||||
- JavaScript: programming language for the whole application
|
||||
- CSS: styling the user interface using [CSS Modules](https://github.com/css-modules/css-modules)
|
||||
- [React](https://reactjs.org/): library for creating user interfaces with components
|
||||
- [Redux](https://redux.js.org/): state and data flow handling
|
||||
- [Final Form](https://github.com/final-form/final-form): forms
|
||||
- [React Router](https://reacttraining.com/react-router/): routing
|
||||
- [Express](https://expressjs.com/): server
|
||||
|
||||
## Setup
|
||||
|
||||
|
|
@ -124,7 +124,7 @@ To develop the application and to see changes live, start the frontend developme
|
|||
|
||||
**Known issues:**
|
||||
|
||||
* Adding/changing `import`s may not be synced properly with ESLint. You may see an error
|
||||
- Adding/changing `import`s may not be synced properly with ESLint. You may see an error
|
||||
`Unable to resolve path to module` even though the module existing in right path. Restarting the
|
||||
server doesn't help. To solve the issue, you need to make a change to the file where the error
|
||||
occurs.
|
||||
|
|
|
|||
|
|
@ -52,13 +52,13 @@ Start the server:
|
|||
|
||||
## Deploying to Heroku
|
||||
|
||||
* [Forking the repository](#forking-the-repository)
|
||||
* [Creating new app](#creating-new-app)
|
||||
* [Connect GitHub to Heroku](#connect-github-to-heroku)
|
||||
* [Heroku settings](#heroku-settings)
|
||||
* [Updating enviroment variables](#updating-enviroment-variables)
|
||||
* [Domains and certificates](#domains-and-certificates)
|
||||
* [Heroku logs](#heroku-logs)
|
||||
- [Forking the repository](#forking-the-repository)
|
||||
- [Creating new app](#creating-new-app)
|
||||
- [Connect GitHub to Heroku](#connect-github-to-heroku)
|
||||
- [Heroku settings](#heroku-settings)
|
||||
- [Updating enviroment variables](#updating-enviroment-variables)
|
||||
- [Domains and certificates](#domains-and-certificates)
|
||||
- [Heroku logs](#heroku-logs)
|
||||
|
||||
Before creating the app you need three accounts: [Heroku](https://heroku.com/),
|
||||
[Stripe](https://stripe.com/fi) and [MapBox](https://www.mapbox.com/). Creating the accounts is free
|
||||
|
|
@ -104,7 +104,7 @@ from any branch in the repository.
|
|||
|
||||
Read more from Heroku docs:
|
||||
|
||||
* [GitHub Integration](https://devcenter.heroku.com/articles/github-integration)
|
||||
- [GitHub Integration](https://devcenter.heroku.com/articles/github-integration)
|
||||
|
||||
### Heroku settings
|
||||
|
||||
|
|
@ -127,8 +127,8 @@ SSH settings in the _Settings tab_.
|
|||
|
||||
Read more from Heroku docs:
|
||||
|
||||
* [Custom Domain Names for Apps](https://devcenter.heroku.com/articles/custom-domains)
|
||||
* [Manually Acquiring an SSL/TLS Certificate](https://devcenter.heroku.com/articles/acquiring-an-ssl-certificate)
|
||||
- [Custom Domain Names for Apps](https://devcenter.heroku.com/articles/custom-domains)
|
||||
- [Manually Acquiring an SSL/TLS Certificate](https://devcenter.heroku.com/articles/acquiring-an-ssl-certificate)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ instead of defining on server-side what gets rendered when user goes to URL
|
|||
`somemarketplace.com/about`, we just catch all the path combinations and let the app to define what
|
||||
page gets rendered.
|
||||
|
||||
* [React Router setup](#react-router-setup)
|
||||
* [Linking](#linking)
|
||||
* [Loading data](#loading-data)
|
||||
* [Analytics](#analytics)
|
||||
* [A brief introduction to server-side rendering](#a-brief-introduction-to-ssr)
|
||||
- [React Router setup](#react-router-setup)
|
||||
- [Linking](#linking)
|
||||
- [Loading data](#loading-data)
|
||||
- [Analytics](#analytics)
|
||||
- [A brief introduction to server-side rendering](#a-brief-introduction-to-ssr)
|
||||
|
||||
## React Router setup
|
||||
|
||||
|
|
@ -144,10 +144,10 @@ const Routes = (props, context) => {
|
|||
Inside `src/Routes.js`, we also have a component called `RouteComponentRenderer`, which has three
|
||||
important jobs:
|
||||
|
||||
* Calling loadData function, if those have been defined in `src/routeConfiguration.js`. This is an
|
||||
- Calling loadData function, if those have been defined in `src/routeConfiguration.js`. This is an
|
||||
asynchronous call, a page needs to define what gets rendered before data is complete.
|
||||
* Reset scroll position after location change.
|
||||
* Dispatch location changed actions to Redux store. This makes it possible for analytics Redux
|
||||
- Reset scroll position after location change.
|
||||
- Dispatch location changed actions to Redux store. This makes it possible for analytics Redux
|
||||
middleware to listen location changes. For more information, see the
|
||||
[How to set up Analytics for FTW](https://www.sharetribe.com/docs/guides/how-to-set-up-analytics-for-ftw/)
|
||||
guide in Flex Docs.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue