react-webpack-boilerplate

React-based boilerplate using Webpack bundler, written for personal use as a template repository.

Installation

GitHub installation

Link to GitHub docs

Non-GitHub installation

1. Create a new repository on your GitHub and a directory on your machine with the same name.

mkdir your-project

2. Clone this boilerplate to your local directory.

git clone https://github.com/jackshen/react-webpack-boilerplate.git your-project
cd your-project

3. Remove .git and reinitialize with the repository you created in step 1.

rm -rf .git
git init
git remote add origin [email protected]:path/to/your-project.git
git add .
git commit -m "Initial commit"
git push -u origin master

Setup

Copy .env.example into .env; sensible default configuration values have been provided for your convenience, but feel free to update these as you wish.

From there, run the following commands to run the application:

yarn
yarn start

Testing

To run Cypress E2E tests:

yarn test:cypress

Make sure that the app is running in a separate terminal prior to running the tests.

Technologies

• Bundler: Webpack
• Framework: React/TypeScript
• Linting: ESLint, Prettier
• Styling: CSS, Sass, styled-components
• Testing: Cypress

License

MIT