@biko/react-scripts []

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

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

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! 🚀

tl;dr

npx create-react-app my-app --scripts-version=@biko/react-scripts
cd my-app
npm start

(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.

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.

Just create a project, and you’re good to go.

Creating an App

You’ll need to have Node >= 6 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.

To create a new app, run a single command:

npx create-react-app my-app

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

Using yarn:

yarn add -D typescript

No configuration or complicated folder structures, just the files you need to build your app.
Once the installation is done, you can open your project folder:

cd my-app

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.

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:

• Updating to New Releases
• Folder Structure
• Available Scripts
• Supported Browsers
• Supported Language Features and Polyfills
• Syntax Highlighting in the Editor
• Displaying Lint Output in the Editor
• Formatting Code Automatically
• Debugging in the Editor
• Changing the Page <title>
• Installing a Dependency
• Importing a Component
• Code Splitting
• Adding a Stylesheet
• Post-Processing CSS
• Adding a CSS Preprocessor (Sass, Less etc.)
• Adding Images, Fonts, and Files
• Using the public Folder
• Using Global Variables
• Adding Bootstrap
• Adding Flow
• Adding a Router
• Adding Custom Environment Variables
• Can I Use Decorators?
• Fetching Data with AJAX Requests
• Integrating with an API Backend
• Proxying API Requests in Development
• Using HTTPS in Development
• Generating Dynamic <meta> Tags on the Server
• Pre-Rendering into Static HTML Files
• Running Tests
• Debugging Tests
• Developing Components in Isolation
• Publishing Components to npm
• Making a Progressive Web App
• Analyzing the Bundle Size
• Deployment
• Advanced Configuration
• Troubleshooting

A copy of the user guide will be created as README.md in your project folder.

How to Update to New Versions?

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

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:

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
}

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.

Changelog

0.9.0

• Ahora prettier elimina los semicolons al final de las líneas
• Actualizada la plantilla base de ficheros

0.8.0

• Añade la posibilidad de añadir nuevos plugins a webpack a través de ficheros en el raiz del proyecto con el nombre: webpack.config.dev.extension.js y webpack.config.prod.extension.js El formato completo de los ficheros se actualiza a:

module.exports = {
  getRules: function() {
    return [];
  },
  getPlugins: function() {
    return [];
  },
};

Además, con el cambio realizado a partir de ahora los métodos de extension son opcionales y no es obligatorio definirlos si no es necesario.

0.7.0

• Añade un transformador para ts-loader que, en desarrollo, añade el nombre del componente al nombre del estilo de styled-componented para facilitar su depuración.

0.6.0

• Añade la posibilidad de añadir nuevas reglas a webpack a través de ficheros en el raiz del proyecto con el nombre: webpack.config.dev.extension.js y webpack.config.prod.extension.js El formato de los ficheros es:

module.exports = {
  getRules: function() {
    return [];
  },
};

0.5.3

• Nueva opción de configuración para la tarea 'build', llamada 'JS_SOURCEMAPS_ARE_HIDDEN' donde TRUE genera sourcemaps pero no enlazados en los ficheros javascript.

0.5.0

• Actualizado a react-scripts v1.1.1
• Nueva configuración para separar en chunks el contenido de "node_modules", la configuración del "manifest" y los common chunks
• Incorporada herramienta para el análisis de los chunks. En la compilación a producción generar un informe en .html

0.4.0

• Añadida configuración de Prettier al template
• Añadido soporte para módulos CSS para ficheros .module.css y .module.scss

0.3.1

• Añadido soporte de SASS

• No Configuration Required: You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.

• No Lock-In: You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.

What’s Included?

Your environment will have everything you need to build a modern single-page React app:

• 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.

Check out this guide for an overview of how these tools fit together.

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.

Popular Alternatives

Create React App is a great fit for:

• Learning React in a comfortable and feature-rich development environment.
• Starting new single-page React applications.
• Creating examples with React for your libraries and components.

Here’s a few common cases where you might want to try something else:

• If you want to try React without hundreds of transitive build tool dependencies, consider using a single HTML file or an online sandbox instead.

• 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.

• If you need to publish a React component, nwb can also do this, as well as Neutrino's react-components preset.

• If you want to do server rendering with React and Node.js, check out Next.js or Razzle. Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.

• If your website is mostly static (for example, a portfolio or a blog), consider using Gatsby instead. Unlike Create React App, it pre-renders the website into HTML at the build time.

• If you want to use TypeScript, consider using create-react-app-typescript.

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

All of the above tools can work with little to no configuration.

If you prefer configuring the build yourself, follow this guide.

Contributing

We'd love to have your helping hand on create-react-app! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

React Native

Looking for something similar, but for React Native?
Check out Create React Native App.

Acknowledgements

We are grateful to the authors of existing related projects for their ideas and collaboration:

• @eanplatter
• @insin
• @mxstbr