Git Product home page Git Product logo

react-typescript's Introduction

React & typescript boilerplate Build is passing? Coverage Status Maintainability

Deprecated notice

Use nextjs

Why?

Make it fast as possible. Current development environment starts in <10s Build time as fast as possible ~35s. Bundle size should be minimum as possible performance

How to start

  1. yarn Install dependencies
  2. Copy .env.example to .env
  3. yarn start Start development
  4. yarn start:storybook Start storybook
  5. yarn build Build for production
  • Optional: Install wallaby plug-in for you IDE
  1. Configure wallaby test runner
  2. yarn test Run tests to check if everything is working
  3. yarn prepush Run before each push
  4. yarn start:server Start the server with SR (Server side rendering)

What's inside

Available commands

Command Description
yarn dev Start development environment
yarn start Start production environment
yarn start:storybook Start storybook
yarn lint Lint typescript files
yarn lint:css Lint scss/css files
yarn test Start test enviroiment for development
yarn test:coverage Display tests coverage
yarn start:server Test SSR locally

Contribute

Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the our change log.

The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard (Commitizen). To use the wizard, run yarn run cm in your terminal after staging your changes in git.

A detailed explanation borrowed from angular and can be found in this document.

Todo

  • Automate Changelist.md
  • E2E Tests
  • i18n
  • Red box for react errors?
  • Server side rendering
  • Use redux-observable instead saga
  • Assets (css, js) caching
  • HMR route v4
  • PWA

react-typescript's People

Contributors

aivarasbiliunas avatar fdiskas avatar gennbo avatar snyk-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

react-typescript's Issues

Convert files to LF line endings

Right now there is mix of windows style and Unix stile line endings.
Make them all unix like LF
And fix feature files using .gitattributes

Deploy story book

Story book should be deployed in a sub directory of the demo app

e.x.: docs/

Source map

Source maps are generated but not working

Update readme

There is some missing features in the readme like "prettier"

Update dependencies

Currently new Babel supports typescript. Use it.
Also update security and deprecation varnings.

  • Use babel
  • Update dependencies
  • Fix security issues
  • Fix CI

Demo is not working

v1.4.2 released demo is not working.
Add e2e tests to check if the build is ok befor deploy.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.