Light

patricklizon / react-typescript-core-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 0.0 1.5 MB

Simple boilerplate for TypeScript and React SPAs

JavaScript 45.20% CSS 6.88% HTML 1.22% TypeScript 46.69%

boilerplate boilerplate-front-end typescript react eslint prettier webpack postcss

react-typescript-core-boilerplate's Introduction

core-boilerplate · most basic SPA boilerplate

< short description >

Table of content

Prerequisites
Setup
Resources
Stack
Scripts

Prerequisites

Node - version specified in .nvmrc file.
npm - usually comes with node.

It's recommended to use node version manger (ie. fnm), for easier switching between different projects.

Setup

# Copy environmental variables
cp .env.example .env

# Install dependencies
npm ci

# Start dev server
npm start

Resources

< section description >

Stack

Frontend

TypeScript - typed language build on top of JavaScript,
React - ui library used for development,
CSS modules - scoped css

Tools

webpack - bundler
swc - javascript / typescript compiler
eslint - static code analysis
prettier - code formatter
autoprefixer - PostCSS plugin to parse CSS and add vendor prefixes to CSS rules

Testing

jest - test runner
chai - assertion library
testing-library - testing utilities
user-event - more advanced simulation of browser interactions

Scripts

Summary of npm scripts.

General

Script	Description
`start`	starts application in DEV mode
`build`	builds app in PROD mode
`build:perf`	builds app in react performance debugging mode
`serve`	serves build application

Test

Script	Description
`test`	run unit tests
`test:coverage`	run `test` in watch mode
`test:watch`	run `test` and generate coverage report

Checks

Script	Description
`check:types`	validates TS types
`check:format`	validates code formatting
`check:lint`	validates linting rules
`check:lint-staged`	run `fix:format` and `fix:lint` on staged files
`check:imports`	checks for unimported code

Fix

Script	Description
`fix:format`	tries to fix formatting
`fix:lint`	tries to fix linter issues

react-typescript-core-boilerplate's People

Contributors

Stargazers

Watchers

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.