Widget Library Starter with Create-React-App

React boilerplate for creating widget libraries that may be embedded.

Getting Started

This project was bootstrapped with Create React App, React App Rewired and Customize-CRA.

Installation

Installation

You can get the project on your local computer by either downloading the zip file or cloning it into your preferred directory using the link provided.

• To clone, open your terminal and run the command:

  cd ~/Desktop
  git clone {{the link you just copied}} project-name

• In the Project directory, run:

cd ~/Desktop/project-name
yarn

or

cd ~/Desktop/project-name
npm install

This installs all dependencies.

• Run locally:

npm start

Open http://localhost:3000 to view it in the browser.

Available Scripts

In the project directory, you can run:

npm start

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

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Using react-app-rewired to build the app for production to the build folder.
It creates a single javascript file which can then be embedded into your application.
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.
The single javascript file widget.js contains the javascript file that will be loaded into your application.
Your app is ready to be deployed!

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Features

• Have access to CRA boilerplate.

• Exports in a umd format so the library works everywhere.

• Generates a single bundle javascript file.

• Bundles css into javascript files.

• Allows for easy modification.