Skip to content

gilbsgilbs/create-react-app-typescript

 
 

Repository files navigation

<<<<<<< HEAD

react-scripts-ts npm version Build Status

=======

Create React App Build Status

facebook/next

Create React apps (with Typescript) with no build configuration.

<<<<<<< HEAD

Do you know react and want to try out typescript? Or do you know typescript and want to try out react? Get all the benefits from create-react-app but you use typescript! 🚀

Create React App works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.

facebook/next

tl;dr

npm install -g create-react-app

create-react-app my-app --scripts-version=react-scripts-ts
cd my-app/
npm start

<<<<<<< HEAD

Migration

======= (npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Then open http://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle with npm run build.

npm start

Get Started Immediately

facebook/next

In general, most upgrades won't require any migration steps to work, but if you experience problems after an upgrade, please file an issue, and we'll add it to the list of migration steps below.

From <2.16.0 to >=2.16.0

Since 2.16.0, the template uses different tsconfig files for both development and production mode. For the latter, unfortunately, the path resolver is not smart enough to fall back to the basic tsconfig.json in case the expected tsconfig.prod.json is not present, so you have to create this file manually like shown here.

From <2.13.0 to >=2.13.0

Since 2.13.0, typescript is listed as a peer dependency of react-scripts-ts. For projects generated with at least this version, the init script takes care of properly installing it as dev dependency to the generated projects. Older projects require manual installation, in case you have not already done that.

Using npm:

npm i -D typescript

Using yarn:

yarn add -D typescript

<<<<<<< HEAD

From <2.5.0 to >=2.5.0

Version 2.5.0 introduces a new config file for jest, that is necessary for the tests to run. If you were previously running a version older than v2.5.0 and upgraded to v2.5.0 or newer, you need to manually add the new file, or else you'll get an error similar to this when trying to run your tests:

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.

Build errors

npm test or yarn test

Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.

Read more about testing.

npm run build or yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
By default, it also includes a service worker so that your app loads from local cache on future visits.

Your app is ready to be deployed.

User Guide

The User Guide includes information on different topics, such as:

facebook/next

Test suite failed to run

{
    "messageText": "Cannot read file 'C:\\[project]\\tsconfig.test.json': ENOENT: no such file or directory, open 'C:\\[project]\\tsconfig.test.json'.",
    "category": 1,
    "code": 5012
}

<<<<<<< HEAD To fix this, create a new file in the root of the project called tsconfig.test.json, and paste the content of this file into it. Everything should work now. For more info, please see this issue.

Please refer to the User Guide for this and other information.

facebook/next

Changelog

2.16.0

  • Allow moduleNameMapper config override - @sebald
  • Fix travis build - @DorianGrey
  • Allow using different tsconfig file for dev and build - @DorianGrey

2.15.1

  • Fix duplicated mjs entry in Jest config - @StevenLangbroek
  • Allow --watchAll to be set - @DorianGrey

2.15.0

  • Replace TSLint rules with presets - @nielsdB97
  • Update file-loader exclusion rules - @winstonewert
  • Fix Uglifyjs settings - @meandmax
  • Merge react-script 1.1.x - @wmonk

2.14.0

  • README fixes - @kaminskypavel
  • README fixes - @adambowles
  • Remove unused JS files - @DorianGrey
  • README fixes - @stephtr
  • Added the abillity to import js and jsx files with ts-loader - @GeeWee
  • Uglifyjs update for es6 support - @thetric

2.13.0

  • Remove tslint-loader from prod builds - @DorianGrey
  • Include typescript as devDependency in boilerplate - @ianschmitz
  • Document custom module formats - @joshtynjala
  • Fix tsconfig.json - @diabelb

<<<<<<< HEAD

2.12.0

  • Update typescript to 2.6.2 =======
  • React, JSX, ES6, and Flow syntax support.
  • Language extras beyond ES6 like the object spread operator.
  • Autoprefixed CSS, so you don’t need -webkit- or other prefixes.
  • A fast interactive unit test runner with built-in support for coverage reporting.
  • A live development server that warns about common mistakes.
  • A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps.
  • An offline-first service worker and a web app manifest, meeting all the Progressive Web App criteria.
  • Hassle-free updates for the above tools with a single dependency.

facebook/next

2.11.0

<<<<<<< HEAD

2.10.0

  • README updates - StefanSchoof
  • README updates - DorianGrey
  • Add support for fork-ts-checker-webpack-plugin - johnnyreilly ======= The tradeoff is that these tools are preconfigured to work in a specific way. If your project needs more customization, you can "eject" and customize it, but then you will need to maintain this configuration.

facebook/next

2.9.0 - UNPUBLISHED

This included changes that were not published by the facebook upstream, so was unpublished.

2.8.0

  • Update typescript to 2.5.3 - @nicolaserny

2.7.0

  • Merge react-scripts@1.0.13 - @JohnNilsson
  • Fix git tempalte - @hktonylee
  • Provide migration docs - @JReinhold
  • Updated dependencies - @swengorschewski
  • Fix tslint config - @comerc

2.6.0

  • Merge react-scripts@1.0.10 - @wmonk
  • Update component template - @pelotom

2.5.0

  • Support dynamic imports - thanks @nicolaserny, @DorianGrey
  • Fix up tsconfig - thanks @js-n
  • Fix readme typo - thanks @adambowles
  • Move to ts-jest - thanks @DorianGrey

<<<<<<< HEAD

2.4.0

  • Upgrade typescript to 2.4 and ts-loader to 2.2.1 - thanks @frederickfogerty
  • Fix readme typo - thanks @wrongway4you =======
  • If you need to integrate React code with a server-side template framework like Rails or Django, or if you’re not building a single-page app, consider using nwb, or Neutrino which are more flexible. For Rails specifically, you can use Rails Webpacker.

facebook/next

2.3.2

  • Fix typescript version to 2.3.x until 2.4 @types are fixed

2.3.1

  • All tsc to parse config (for extend) - Thanks to @DorianGrey
  • Fix various jest issues - thanks to @zinserjan
  • Fix code coverage - thanks to @zinserjan

2.2.0

<<<<<<< HEAD

2.1.0

  • Update to tslint@5.2.0 - thanks to @mindjuice

  • Fix test setup issue - thanks to @jonmpqts

  • Add source-map-loader - thanks to @Place1

  • Update to typescript@2.3.3 - thanks to @sjdweb =======

  • If you want to use Parcel instead of Webpack as your bundler, consider using create-react-app-parcel.

  • Finally, if you need more customization, check out Neutrino and its React preset.

facebook/next

2.0.1

  • Fix issue with jest finding test files

2.0.0

1.4.0

  • Upgrade to typescript@2.3.2 - thanks to @patrick91
  • Add tests around react-scripts-ts - thanks to @migerh

1.3.0

  • Upgrade to typescript@2.2.2 - thanks to @jeremistadler

1.1.8

  • Fix regression where no @types were being installed on init

1.1.7

  • Merge facebookincubator/create-react-app@0.9.5 into react-scripts-ts
  • Merge facebookincubator/create-react-app@0.9.4 into react-scripts-ts
  • Merge facebookincubator/create-react-app@0.9.3 into react-scripts-ts
  • Merge facebookincubator/create-react-app@0.9.2 into react-scripts-ts
  • Merge facebookincubator/create-react-app@0.9.1 into react-scripts-ts

1.1.6

  • Merge facebookincubator/create-react-app@0.9.0 into react-scripts-ts

1.0.6

  • Add missing cli-highlight dependency

1.0.5

  • Print file names when running npm run build
  • Add support for setupTest.ts
  • Highlight source code when erroring in npm run build

1.0.4

  • Change mentions of eslint to tslint

1.0.3

  • Remove hidden character from tsconfig.json

<<<<<<< HEAD

1.0.2

License

Create React App is open source software licensed as MIT.

facebook/next

About

Create React apps using typescript with no build configuration.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.6%
  • Other 1.4%