More Premium Hugo Themes Premium React Themes

TypescriptReactBoilerplate

Cutting-edge boilerplate for building Typescript NPM modules. Built on best modern practices.

TypescriptReactBoilerplate

Cutting-edge boilerplate for building Typescript NPM modules. Built on best modern practices.

Author Avatar Theme by ctaylo21
Github Stars Github Stars: 8
Last Commit Last Commit: Dec 11, 2020 -
First Commit Created: Jun 19, 2023 -
TypescriptReactBoilerplate screenshot

Overview:

This product is a build system for NPM modules that aims to provide a comprehensive set of features and tools to support development and testing. It uses rollup.js to build the NPM module in multiple formats, supports testing in both node and browsers, and can compile cutting-edge TypeScript to a version that older browsers can support. The build system enforces code standards using ESLint, provides continuous integration and code coverage reporting with Travis CI and Coveralls, and includes features for TDD such as hot-reloading, code coverage, and snapshots with Jest.

Features:

  • Compliant: Uses rollup.js to build the NPM module in multiple formats (ESM and CJS) to support all major use cases for NPM.
  • Testable: Built for TDD with hot-reloading, code coverage, snapshots, and more with Jest.
  • Isomorphic: Supports testing in both node and browsers with jsdom for DOM emulation in tests.
  • Compatible: Writes cutting-edge TypeScript and compiles it to a version that older browsers support. Supports loading of .svg files as React components using rollup.
  • Consistent: Uses ESLint to automatically enforce code standards via git hooks using husky and lint-staged, and commitzen to enforce git commit standards.
  • Continuous: Uses Travis CI and Coveralls to create a CI pipeline that builds the code on merges to master, runs tests, and reports on code coverage.

Installation:

  1. Clone the repository into your “new-project” directory.
  2. Remove the git repository, and then initialize a new one.
  3. Remove README and replace with your own.
  4. Update package.json and install dependencies.
  5. Don’t forget to update the description and any URLs in the package.json file.
  6. Start coding!

Summary:

This product is a comprehensive build system for NPM modules that provides various features and tools to support development and testing. It allows for easy building of the module in multiple formats, supports testing in both node and browsers, enforces code standards, and provides continuous integration and code coverage reporting. The installation process is straightforward, and users can quickly start coding after setting up the project.