mirror of
https://github.com/kingomarnajjar/flex-template-web.git
synced 2026-07-26 06:47:17 +10:00
Prefer the word customize over customise
This commit is contained in:
parent
4c00c1986d
commit
c50dc86559
9 changed files with 23 additions and 23 deletions
|
|
@ -3,7 +3,7 @@
|
|||
[](https://circleci.com/gh/sharetribe/flex-template-web)
|
||||
|
||||
This is a template web application for a Sharetribe Flex marketplace ready to be extended and
|
||||
customised. It is based on an application bootstrapped with
|
||||
customized. It is based on an application bootstrapped with
|
||||
[create-react-app](https://github.com/facebookincubator/create-react-app) with some additions,
|
||||
namely server side rendering and a custom CSS setup.
|
||||
|
||||
|
|
@ -27,9 +27,9 @@ 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 following section.
|
||||
|
||||
## Getting started with your own customisation
|
||||
## Getting started with your own customization
|
||||
|
||||
If you want to build your own Flex marketplace by customising the template application, see the
|
||||
If you want to build your own Flex marketplace by customizing the template application, see the
|
||||
[Customization guide](docs/customization-guide.md) documentation.
|
||||
|
||||
## Documentation
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Customisation checklist
|
||||
# Customization checklist
|
||||
|
||||
Some generic things to update and check when starting to customise the template.
|
||||
Some generic things to update and check when starting to customize the template.
|
||||
|
||||
* [Marketplace colors](styling.md)
|
||||
* [Generate app icons](icons.md)
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Customisation guide
|
||||
# Customization guide
|
||||
|
||||
So you've decided to build your own Flex marketplace using the template. That's awesome! This guide
|
||||
will help you in setting up your fork and describes the general workflow.
|
||||
|
||||
**Note:** if you cloned the repository like described in the Quick start section of the project
|
||||
README file, you probably don't want to make the customisations in that project. Forking the
|
||||
README file, you probably don't want to make the customizations in that project. Forking the
|
||||
repository is the recommended way to proceed. Follow this guide for instructions.
|
||||
|
||||
## Requirements
|
||||
|
|
@ -17,7 +17,7 @@ Install required tools:
|
|||
## Technologies
|
||||
|
||||
Depending on what you want to change in the template, various skills help in achieving your goal.
|
||||
Some of the basic customisations don't require specific coding skills, but many customisations
|
||||
Some of the basic customizations don't require specific coding skills, but many customisations
|
||||
become technically involved. We've tried to keep the technology setup as simple as possible, and
|
||||
frontend developers with experience in widely used tooling should feel comfortable right from the
|
||||
get-go.
|
||||
|
|
@ -35,7 +35,7 @@ Here are some main technologies that the template uses:
|
|||
|
||||
## Setup
|
||||
|
||||
To start a new customisation project, you should create a separate Git repository and setup the Git
|
||||
To start a new customization project, you should create a separate Git repository and setup the Git
|
||||
remotes so that you can pull in changes from the main (upstream) repository to your custom
|
||||
repository.
|
||||
|
||||
|
|
@ -56,12 +56,12 @@ documentation.
|
|||
|
||||
### Pull in latest upstream changes
|
||||
|
||||
If you want to update your local customisation project with changes in the template, you should pull
|
||||
If you want to update your local customization project with changes in the template, you should pull
|
||||
in changes from the upstream remote.
|
||||
|
||||
**Note:** Depending on the changes you've made to the template, this might be hard/impossible
|
||||
depending on what has changed in the template. You should mainly think of the template being the
|
||||
starting point of your customisation, not something that is constantly updated.
|
||||
starting point of your customization, not something that is constantly updated.
|
||||
|
||||
In the `master` branch (or in the branch you want to merge in the upstream changes):
|
||||
|
||||
|
|
@ -138,8 +138,8 @@ To start the test watcher, run
|
|||
|
||||
See more in the [testing documentation](docs/testing.md).
|
||||
|
||||
## Customisation
|
||||
## Customization
|
||||
|
||||
There are many things that you should change in the default template, and many more that you can
|
||||
change. See the [Customisation checklist](customisation-checklist.md) documentation for more
|
||||
change. See the [Customization checklist](customization-checklist.md) documentation for more
|
||||
information.
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@ suit the marketplace.
|
|||
|
||||
Edit
|
||||
[src/components/TermsOfService/TermsOfService.js](../src/components/TermsOfService/TermsOfService.js)
|
||||
file to customise the default dummy content.
|
||||
file to customize the default dummy content.
|
||||
|
||||
## Privacy Policy
|
||||
|
||||
Edit
|
||||
[src/components/PrivacyPolicy/PrivacyPolicy.js](../src/components/PrivacyPolicy/PrivacyPolicy.js)
|
||||
file to customise the default dummy content.
|
||||
file to customize the default dummy content.
|
||||
|
|
|
|||
2
icons.md
2
icons.md
|
|
@ -1,7 +1,7 @@
|
|||
# Icons
|
||||
|
||||
The default icons are generated with [RealFaviconGenerator](https://realfavicongenerator.net/). You
|
||||
can upload your original icon to the tool, customise the colors and themes, and download a generated
|
||||
can upload your original icon to the tool, customize the colors and themes, and download a generated
|
||||
set if icons and an HTML snippet to point to those images.
|
||||
|
||||
1. Open https://realfavicongenerator.net/
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ const devImagesMaybe = dev ? ['*.localhost:8000'] : [];
|
|||
|
||||
// Default CSP whitelist.
|
||||
//
|
||||
// NOTE: Do not change these in the customisations, make custom
|
||||
// NOTE: Do not change these in the customizations, make custom
|
||||
// additions within the exported function in the bottom of this file.
|
||||
const defaultDirectives = {
|
||||
baseUri: [self],
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Listing page consists of the generic Topbar and of different page sections:
|
|||
* **Main content**: the left column under images
|
||||
* **SectionBooking**: Contains the form and breakdown estimation for booking the listing
|
||||
|
||||
In the main content, there are several sections that are likely to be customised, e.g. when adding
|
||||
In the main content, there are several sections that are likely to be customized, e.g. when adding
|
||||
new extended data to the listing creation.
|
||||
|
||||
## Server rendering
|
||||
|
|
@ -25,4 +25,4 @@ metadata properly.
|
|||
## SEO
|
||||
|
||||
As mentioned above, the listing page is important for search engines and other bots. Therefore it is
|
||||
important to ensure that the schema metadata is up to date when making customisations to the page.
|
||||
important to ensure that the schema metadata is up to date when making customizations to the page.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ export class BookingDatesFormComponent extends Component {
|
|||
|
||||
// This is the place to collect breakdown estimation data. See the
|
||||
// EstimatedBreakdownMaybe component to change the calculations
|
||||
// for customised payment processes.
|
||||
// for customized payment processes.
|
||||
const bookingData =
|
||||
startDate && endDate
|
||||
? {
|
||||
|
|
|
|||
|
|
@ -7,14 +7,14 @@
|
|||
* estimate the breakdown of the transaction without data from the
|
||||
* API.
|
||||
*
|
||||
* If the payment process of a customised marketplace is something
|
||||
* If the payment process of a customized marketplace is something
|
||||
* else than simply daily or nightly bookings, the estimation will
|
||||
* most likely need some changes.
|
||||
*
|
||||
* To customise the estimation, first change the BookingDatesForm to
|
||||
* To customize the estimation, first change the BookingDatesForm to
|
||||
* collect all booking information from the user (in addition to the
|
||||
* default date pickers), and provide that data to the
|
||||
* EstimatedBreakdownMaybe components. You can then make customisation
|
||||
* EstimatedBreakdownMaybe components. You can then make customization
|
||||
* within this file to create a fake transaction object that
|
||||
* calculates the breakdown information correctly according to the
|
||||
* process.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue