Boilerplate TSX ✔️

Typescript web application boilerplate

How to run?

You can run it by using docker, docker-compose or your local environment:

Configure keys

cp .env.example .env
nano .env

Using Docker?

To build the image:

docker build -t [your-tagname-here] .

To run the image:

docker run -it --rm -v ${PWD}:/app -v /app/node_modules \
  -p [your-configured-port-here]:[your-configured-port-here] \
  -e CHOKIDAR_USEPOLLING=true \
  [your-tagname-here]

Using Docker compose?

docker-compose up --build

Install

yarn install

Local usage

yarn start

Tests

# regular test
yarn test

# test in watch mode
yarn test:watch

# coverage
yarn test:cov

E2E tests

# headless browser
yarn test:e2e

# running on chrome
yarn test:e2e:browser

Build

# build for production
yarn build

# analyzing bundle size
yarn analyze

Lint

# check lint issues
yarn lint

# fix lint issues
yarn lint:fix

Build with

• cra - Most common boilerplate to start react projects
• typescript - JavaScript extention to add types to the language
• cypress - Created to easily test end to end front-end

TODO

• [] Add storybook

Author

🦊 William G.

• Github: @rap0so
• LinkedIn: @william-godoy-4bb919b5

📝 License

Copyright © 2020 William G..
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator