Skip to content

Template for TypeScript Projects

License

Notifications You must be signed in to change notification settings

Hexafuchs/ts-package-template

 
 

Repository files navigation

:package_description

Latest Version on NPM GitHub Tests Action Status GitHub Code Style Action Status Monthly Downloads

This repo can be used to scaffold a Python package. Unless you are a member of Hexafuchs, please use the Original Template by kbysiec or edit out any references to us except of copyright references.

Follow these steps to get started:

  1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
  2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
  3. Have fun creating your package.

Note: Remember to activate discussions in the repository settings.

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via npm (or another tool of your choosing):

npm install @hexafuchs/:package_name

Usage

Checkout the documentation at https://hexafuchs.github.io/:package_name/.

import { sum } from "@hexafuchs/:package_name";

Testing

npm run test

Development

Building

npm run build

Dev Server

npm run dev

Run linter

npm run lint:scripts
npm run lint:styles

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

About

Template for TypeScript Projects

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 79.3%
  • TypeScript 16.8%
  • HTML 3.9%