guillaumek / react-parcel-cypress-boilerplate

README

A minimal React.js boilerplate with Parcel bundler, including testing tools and deployable on aws s3.

Table of Contents

• Installation
• Start
• Testing
• Deployment
• Usage
• Resources
• Support
• Contributing

Installation

Clone the repository in your project folder:

yarn install

Start

Start the application:

yarn start

Build the application

yarn build:[dev|staging|prod]

Deployment

In order to deploy add 'name' to your AWS profile ~/.aws/credentials:

[name]
aws_access_key_id= XXXX
aws_secret_access_key= XXXXX

Deploy using the following command:

yarn deploy:[dev|staging|prod]

Testing

Unit Testing

Jest is a testing solution developped by Facebook for react application. In order to run application test, use the following command:

yarn test

Integration Testing

Integration testing is addressed by Cypress tool. It can be compared to Selenium. In order to run integration use the following command:

yarn cypress:open

You must have a server running to test against

Usage

TBC.

Resources

TBC.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.