TS & React Application Template

A condensed template for lightweight & scalable web applications built with TypeScript, React, and Sass

This is a template for building a scalable single-page application using [React]. To keep things simple and expandable, this template doesn't rely upon any unnecessary tools. Whether you're creating a small tool or beginning a large project, this is a strong place to begin.

Technologies Overview

Directory Overview

To reference a project built with this template, see this dummy application.

To use this template

  • Install Node
  • Fork this repository & rename it to your project's name.
  • Clone the forked repository to your computer.
  • Open a terminal in the root directory of the cloned repository.
  • Run npm i in the terminal.

From here, you're ready to devlelop your project.

Scripts

To run a script, type npm run <script-name>

script-name description
build call build:dev
build:dev try to compile the application into /bin/
build:prod try to compile an optimized version of the application into /bin/
start call start:dev
start:dev build:dev & start a hot-reloading server at localhost:1000
start:prod build:prod & start a server at localhost:1111
test run all Jest unit tests and produce a coverage report
test:watch test & rerun when files are updated

To edit commands, see "scripts" in package.json

To contribute to this template

Unfortunately, this template doesn't support user contributions right now.