https://github.com/SocketSomeone/typescript-open-source-template

📜 My template for creating TypeScript Open Source projects
https://github.com/SocketSomeone/typescript-open-source-template

npm open-source template typescript

Last synced: 16 days ago
JSON representation

📜 My template for creating TypeScript Open Source projects

• Host: GitHub
• URL: https://github.com/SocketSomeone/typescript-open-source-template
• Owner: SocketSomeone
• License: mit
• Created: 2023-04-11T18:03:56.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-10T03:30:37.000Z (6 months ago)
• Last Synced: 2024-04-10T04:59:43.949Z (6 months ago)
• Topics: npm, open-source, template, typescript
• Homepage:
• Size: 1.63 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# typescript-open-source-template

This is a template for creating a new open source project in TypeScript.

## Features

* [TypeScript](https://www.typescriptlang.org/)

* [Jest](https://jestjs.io/)

* [ESLint](https://eslint.org/)

* [Prettier](https://prettier.io/)

* GitHub Actions

* [Dependabot](https://dependabot.com/)

* Semantic Release

* Commitizen

* Commitlint

* [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

* [Semantic Versioning](https://semver.org/)

## Usage

1. Click the "Use this template" button to create a new repository from this template.

2. Clone the new repository to your local machine.

3. Run `npm install` to install dependencies.

4. Replace name, description, and other fields in `package.json` with your own.

5. Replace the contents of this file with your own.

6. Replace name of package at github actions workflow file

## Scripts

* `npm run build` - Compile TypeScript to JavaScript.

* `npm run lint` - Lint TypeScript files.

* `npm run test` - Run tests.

* `npm run publish:npm` - Publish package to npm.

* `npm run publish:dev` - Publish package to npm with `dev` tag.