sharetribe-scripts

This is a fork of the react-scripts package from the facebook/create-react-app monorepo. You can refer to its documentation:

• Getting Started – How to create a new app.
• User Guide – How to develop apps bootstrapped with Create React App.

This package is published as sharetribe-scripts in NPM.

See the description field in package.json to see which version of react-scripts this fork is built from.

Differences to react-scripts

• Use postcss-preset-env with live CSS Custom Properties.
• Use postcss-import
• Use postcss-apply
  • There's naive implementation of PostCSS apply plugin that works on top of PostCSS v8
  • However, you should consider @apply syntax to be deprecated. We won't support it indefinitely.
• Use Loadable components
  • Use these versions in your client app: "@loadable/component": "^5.15.2", "@loadable/server": "^5.15.2",
• A separate build-server script that makes a build to use in SSR (server side rendering)
• Show customized instructions how to run the production build bundle

Development

Setup

To update the fork to use a new version of the upstream repository:

1. If you haven't already, configure the upstream repository as a remote:

   git remote add upstream https://github.com/facebookincubator/create-react-app
   

2. Sync the fork to a branch, making sure you merge from a specific version/tag that you want to base your changes on

   git fetch upstream
   git checkout master
   git checkout -b update-from-upstream
   git merge <tag_to_be_merged_here_eg_v1.1.2>
   

3. update package-lock.json in the root of the create-react-app repository (npm install)

4. Make your changes, test them (see below), make a PR, release

Making changes and testing

To test your local changes, use Verdaccio or link the local repository to the application:

Verdaccio

1. Run Verdaccio locally (http://localhost:4873/) and create user there

2. Make changes to this repo and update version in the package.json of this react-scripts dir The version could be something like "6.0.0-alpha"

3. Publish your changes to the local registry

   npm publish --registry http://localhost:4873/
   

4. Go to FTW repo and add .yarnrc file with content:

   registry "http://localhost:4873"
   

5. Modify FTW template's package.json

   "sharetribe-scripts": "6.0.0-alpha",
   

   Then run yarn install

Linking

1. In the create-react-app/packages/react-scripts directory, install dependencies and make a link of the package:

   yarn install # ignore the yarn.lock file
   yarn link
   

   NOTE: if other packages have changed too, you might need to run yarn install # ignore the yarn.lock file on the root folder too.

2. In the application remove the old sharetribe-scripts package and use the linked version (read more):

   yarn remove sharetribe-scripts
   yarn link sharetribe-scripts
   

3. Now you changes to the fork are usable as a symlicked dependency in the application

Publishing

1. Make sure you have updated the version also in the description field in package.json. Try to sync the package version with the original package, if possible.

2. Publish to NPM:

   npm login
   # Check credentials from password manager
   npm publish
   

3. Tag the commit with released version: sharetribe-scripts@x.x