Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.88 KB

README.md

File metadata and controls

35 lines (19 loc) · 1.88 KB

react-client-blueprint

A blueprint for React with Webpack and Babel. React router, Linaria for CSS and Jest with React Testing Library for tests.

Setup

Create a new repository from this template on the Github website by clicking on the create from template button in the top right.

Create a local folder for docker-compose files. cd into it and the clone your new repository. After cloning, rename the clone folder as client. Copy the contents of example.env and example.docker-compose.yml into the parent folder - into files without the example. prefix. If you are combining this with other templates then you will need to merge the contents rather than create new files. Open .env and ensure that CLIENT_HOST_PORT is available locally. If not then edit it appropriately.

Run

From the command line in the folder containing docker-compose.yml :

  • Build with docker-compose build
  • Run with docker-compose up

To install new packages: Run the client docker with docker-compose run client sh and then use npm install <package_name>. Type exit to return to your command line and then rebuild and rerun - only this time add a -V switch... docker-compose up -V. This will force the deletion of the anonymous node_package volume and prevent a docker race condition issue.

The main entry file is ./src/index.js

Routing

Routing is performed with react-router-dom. Main route file is in /src/routes.js

CSS

CSS is implemented via linaria. See ./src/layouts/main.js for an example.

Test

Testing is performed using Jest and SuperTest. See an example in ./foo.test.js. Run tests from the parent folder with docker-compose run client npm run test. For an example of how to test css see ./src/layouts/main.js.

Linting

Linting is done with eslint. Run the linter with docker-compose run client npm run lint.