This is a boilerplate code that can get you started for developing applications written in TypeScript.
Sure, there are more powerful boilerplate generators out there such as Create React app and Vue CLI. But trying to configure your pipeline outside of what these tools are intended to do can be a pain and requires "ejection". I created this project for my own usage (and for you as well) for a much simpler and opinionated way of building app frontends.
This boilerplate is designed to be as simplistic as it can be so that you can add more features yourself without much trouble:
- Build with WebPack 5
- Styled-Components support
- Separate output files for vendor libraries using webpack's DLLPlugin
- Hot Module Replacement on the development server
- Linting using ESLint
- Unit Testing using Jest
The instructions assume that you use NPM as your package manager. Feel free to use other package managers such as Yarn or PNPM.
Clone this repo with your application name as the second argument:
$ git clone https://github.com/vjcagay/typescript-spa-boilerplate.git <application-name>
$ cd <application-name>Then delete this repo's git history and initialize a new one.
Afterwards, npm install to install the dependencies.
To access the development server, run npm start then go to http://0.0.0.0:8080 in your web browser.
To make compiles faster, you can separate the vendor libraries from application code by importing them inside src/ts/dll.ts. You will still need to import them in your code so that WebPack can reference them from the vendor library manifest.
Example:
// index.tsx
import React from "react";
import styled from "styled-components";// dll.ts
import "react";
import "styled-components";Therefore you need to compile the vendor libraries first before the application code. You can see it on the package.json scripts.
Please file an issue if you find a bug or have concerns or make a pull request if you like some sensible changes!