ts-boilerplate
A lightweight TypeScript boilerplate for TDD.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Repository
A lightweight TypeScript boilerplate for TDD.
Basic Info
- Host: GitHub
- Owner: russelporosky
- License: mit
- Language: HTML
- Default Branch: main
- Size: 438 KB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
- Releases: 6
Metadata Files
README.md
TypeScript Boilerplate
This is a lightweight TypeScript boilerplate that uses jest for testing, prettier for formatting, and typedoc for document generation.
Delete or rename the existing src/HelloWorld.ts and src/HelloWorld.spec.ts files to reflect your preferred names.
npm run lint will compare your code against the linter settings. This repository is set to use tabs for indentation and single quotes for strings.
npm run test will run your tests. For a coverage report, use npm run test:coverage. And to have tests watch for changes and automatically re-run, use npm run test:watch.
Support
Reach out to the maintainer at one of the following places:
Contributing
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved!
Authors & contributors
The original setup of this repository is by Russel Porosky.
For a full list of all authors and contributors, check the contributor's page.
Security
TS-Boilerplate follows good practices of security, but 100% security can't be granted in software. TS-Boilerplate is provided "as is" without any warranty. Use at your own risk.
For more info, please refer to the security.
License
This project is licensed under the MIT license.
See LICENSE for more information.
Owner
- Name: Russel Porosky
- Login: russelporosky
- Kind: user
- Repositories: 19
- Profile: https://github.com/russelporosky
Senior level software developer specializing in web applications - front-end and back-end - and browser-based internal tooling.
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: TypeScript Boilerplate
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- orcid: 'https://orcid.org/0009-0007-1865-1775'
given-names: Russel
family-names: Porosky
email: russelporosky@gmail.com
repository-code: 'https://github.com/russelporosky/ts-boilerplate/'
url: 'https://github.com/russelporosky/ts-boilerplate/'
abstract: A lightweight TypeScript boilerplate for TDD.
keywords:
- typescript
- tdd
- boilerplate
- javascript
license: MIT
GitHub Events
Total
Last Year
Dependencies
- 439 dependencies
- @types/jest ^29.0.3 development
- @types/node ^18.7.18 development
- @typescript-eslint/eslint-plugin ^5.37.0 development
- @typescript-eslint/parser ^5.37.0 development
- eslint ^8.23.1 development
- eslint-import-resolver-typescript 3.5.1 development
- eslint-plugin-import ^2.26.0 development
- eslint-plugin-jsdoc ^39.3.6 development
- eslint-plugin-prefer-arrow ^1.2.3 development
- jest ^29.0.3 development
- ts-jest ^29.0.1 development
- typescript ^4.8.3 development
- actions/checkout v3 composite
- actions/setup-node v3 composite