Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
82 lines (54 loc) · 3.46 KB

README.md

File metadata and controls

82 lines (54 loc) · 3.46 KB
Raw

aaa-react-scripts-ts npm version

A customized react-scripts fork for allaboutapps

Create React App Build Status PRs Welcome

Create React apps with no build configuration.

Create React App works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in our Spectrum community.

You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

Quick Overview

node -v
# v10.x.x
yarn create react-app my-app --scripts-version=aaa-react-scripts-ts

This repo exists to patch some things in packages/react-scripts , however we try to track the upstream create-react-app repository as close as possible here (~half-yearly updates).

Changes

  • We strive to support Visual Studio Code as much as possible
  • TypeScript is our language of choice, any projects are scaffolded as if the --typescript option was given
  • GraphQL / Apollo webpack/scripts support
  • Easy overwrite of webpack configurations through a local webpack.js file in the project
  • Automatically installs compatible versions of popular libraries within our organization
  • Support for compile-time safe i18n through customized typings and utils in the projects
  • Sample Login-Page in the frontend code
  • eslintrc is overwritable and still coming with full tslint support.

Semver

Starting with aaa-react-scripts-ts@v3 which is based on react-scripts@v2 we track the upstream repository through meta tags in the package version.

Format: <MAJOR>.<MINOR>.<PATCH>+cra-v<CRAMAJOR>.<CRAMINOR>.<CRAPATCH>

E.g.: 3.0.1+cra-v2.1.3. Major CRA updates will also result in a bump of aaa-react-scripts-ts.

Publishing

pwd
# ~/aaa-create-react-app-typescript

# Ensure everything builds in the CI as expected, you can also test locally:
yarn
lerna bootstrap

# also test locally
yarn create-react-app my-app-xxx
cd my-app-xxx

# Everything works as expected?

# ensure the version in aaa-react-script package.json is updated as expected:
cat packages/react-scripts/package.json | grep version
# "version": "3.0.1+cra-v2.1.5",

# create a new git tag - e.g.
git tag -a v3.0.1-cra-v2.1.5 -m "[email protected] forked at [email protected]"

git push origin-atl v3.0.1-cra-v2.1.5
git push origin-github v3.0.1-cra-v2.1.5

cd packages/react-scripts

npmrc # ensure you use the right npm registry!

# finally run publish!
npm publish