Node.js-Library-Template

A Node.js TypeScript library starter template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

A Node.js TypeScript library starter template to jumpstart your projects!

(back to top)

Getting Started

1. Use this template to create your own library.
2. Replace all node-lib-template in the code with your project's name.
3. Replace all Songkeys in the code with your GitHub username.

Features and acknowledgements:

1. Pure TypeScript.
2. Bundling with tsup.
3. Testing with vitest
4. Releasing with GitHub Action npm-publish.
5. Automatically creating GitHub tags, releases and changelogs with changelogithub.

To use GitHub Actions to publish and release library, you need GH_TOKEN and NPM_TOKEN environment variables configured in your repository.

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add Changelog
• Multi-language Support
  • Chinese
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)