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

Merge pull request #604 from sharetribe/fork-docs

Browse source 
Documentation for forking the project for customisation
This commit is contained in:
Kimmo Puputti 2017-12-19 15:19:55 +02:00 • committed by GitHub
commit 611efbe202
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 56 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -17,3 +17,4 @@ Documentation for specific topics can be found in the following files:
* [Terms of Service and Privacy Policy](terms-of-service-and-privacy-policy.md)
* [i18n](i18n.md)
* [Colors and icons](colors-and-icons.md)
* [Starting a new customisation project](starting-a-new-customisation-project.md)

5
docs/colors-and-icons.md
View file

@ -57,5 +57,6 @@ set if icons and an HTML snippet to point to those images.
## Map marker icon
The map marker icon in the listing can be found in
[src/components/Map/images/marker-32x32.png](../src/components/Map/images/marker-32x32.png). The dimensions
should be 32x32 pixels, so the `favicon-32x32.png` file can be used to replace the map icon.
[src/components/Map/images/marker-32x32.png](../src/components/Map/images/marker-32x32.png). The
dimensions should be 32x32 pixels, so the `favicon-32x32.png` file can be used to replace the map
icon.

52
docs/starting-a-new-customisation-project.md Normal file
View file

@ -0,0 +1,52 @@
# Starting a new customisation project
To start a new project to customise the Starter App, 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.
## Fork the repository
See the [Fork a repo](https://help.github.com/articles/fork-a-repo/) documentation.
**Note:** If you want to make the fork to the same user, you have to start with an empty repository
and follow the next steps in that repository.
## Clone the fork
Go to the directory where you want to clone the repository and run:
```sh
git clone git@github.com:YOUR_USERNAME/YOUR_FORK.git
```
## Set up remotes
In your local fork repository, run:
```sh
git remote add upstream git@github.com:sharetribe/sharetribe-starter-app.git
```
See also the
[Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
documentation.
## Pull in latest upstream changes
In the `master` branch:
1. Fetch the latest changes from the upstream repository:
```sh
git fetch upstream
```
1. Merge the changes to your local branch
```sh
git merge upstream/master
```
1. Fix possible merge conflicts, commit, and push/deploy.
See also the [Syncing a fork](https://help.github.com/articles/syncing-a-fork/) documentation.