create-react-parcel-app

This repository contains the CLI to help facilitate development of React + Parcel SPAs.


Keywords
hacktoberfest
License
MIT
Install
npm install create-react-parcel-app@3.0.0

Documentation

Create React Parcel SPA CLI - create-react-parcel-app

This repository contains the CLI to help facilitate development of React + Parcel SPAs.

Quick Overview

npx create-react-parcel-app

You'll need to answer a few questions and then you are good to go!

cd my-app
npm start

(npx comes with npm 5.2+ and higher)

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

Get Started Immediately

This app uses Parcel. You don’t need to install or configure tools like Webpack or Babel.
Parcel handles all that so that you can focus on the code.

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

Creating an App

You’ll need to have Node >= 12.13.x on your local development machine. You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

To create a new app, you may choose one of the following methods:

npx

npx create-react-parcel-app

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

npm

npm init react-parcel-app

npm init <initializer> is available in npm 6+

Yarn

yarn create react-parcel-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies. The basic folder structure looks like:

my-app
├── README.md
├── node_modules
├── package.json
├── .browserslistrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmrc
├── .nvmrc
├── .postcssrc
└── src
    ├── App.jsx
    ├── App.scss
    ├── index.html
    ├── index.js
    └── index.scss

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:1234 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

This will run tests using Jest and React Testing Library.

npm run build or yarn build

Builds the app for production to the dist 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.

Your app is ready to be deployed.

Older npm version instructions

npm install -g create-react-parcel-app
create-react-parcel-app

Options

There are a few options you can use:

Option Required Default Description
-n <name> N n/a Used to set name of application on the command line.
--no-new-dir N false Flag to not create the application in a new directory. Useful for creating an application in an existing directory/repository.

Local Development

Making updates to the module produced by this repository is simple. Just run npm install and all the dependencies will be downloaded appropriately.

To test the CLI, run node [path-to-this-working-directory]/bin/cli.js from any level above this directory.

Making CLI Updates

There are a few things to remember when making updates to any modules:

  1. Make your code and test changes as necessary.
  2. Update CHANGELOG.md to ensure everyone knows what was changed.
  3. Update package.json with the proper version bump according to Semantic Versioning.

File changes should mimic the following:

CHANGELOG.md

# 0.0.1 - 10/17/2018 - [Zach Wagner](mailto:zwagner86@gmail.com)
-   Published `create-react-parcel-app` CLI to create React SPAs with options for Redux and React Router.

...

package.json

{
  "name": "create-react-parcel-app",
  "version": "0.0.1",
  ...
}