https://github.com/anolilab/monorepo-template

Provides a GitHub mono repository template for a Anolilab Node libraries, using GitHub actions.
https://github.com/anolilab/monorepo-template

anolilab typescript

Last synced: 5 days ago
JSON representation

Provides a GitHub mono repository template for a Anolilab Node libraries, using GitHub actions.

• Host: GitHub
• URL: https://github.com/anolilab/monorepo-template
• Owner: anolilab
• License: mit
• Created: 2021-08-19T12:13:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-15T10:08:43.000Z (5 days ago)
• Last Synced: 2024-11-15T11:20:09.255Z (5 days ago)
• Topics: anolilab, typescript
• Language: Handlebars
• Size: 2.35 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Audit: audit-ci.jsonc
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  Add your motivational tagline here.






---



    


        

            Daniel Bannert's open source work is supported by the community on GitHub Sponsors

        

    



---

## Getting Started

Use the following steps when first using this template.

-   Find and replace

    - `{{ ORGANIZATIONS }}` with your `organization` name

    - {{ REPOSITORY_NAME }} with your `repository name`

    - {{ SCOPED_PACKAGE_NAME }} with your npm `scope name` (don't use the @ at the beginning)

    - {{ ORGANIZATIONS_capitalize }} with your capitalized `organization` name

    across the whole project.

-   Replace the template package in the package's folder with a package of your choosing.

-   For automatic publishing add your npm token to your [GitHub repo secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) with the name `NPM_AUTH_TOKEN`.

-   For automatic publishing add your GitHub token to your [GitHub repo secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) with the name `SEMANTIC_RELEASE_GITHUB_TOKEN`.




## Why

Created this template primarily for my work, to prevent from constantly reinventing the wheel when starting a new project.

Often had ideas and then delayed because the pain of starting from scratch is too high. This toolkit hopefully helps to reduce the friction.

## Versioning

This project uses [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/anolilab/node-mono-library-template/tags).

## Supported Node.js Versions

Libraries in this ecosystem make a best effort to track

[Node.js’ release schedule](https://nodejs.org/en/about/releases/). Here’s [a

post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).

## Contributing

If you would like to help take a look at the [list of issues](https://github.com/anolilab/node-mono-library-template/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild.

> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

## Credits

-   [Daniel Bannert](https://github.com/prisis)

-   [All Contributors](https://github.com/anolilab/node-mono-library-template/graphs/contributors)

## License

The anolilab monorepo-template is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT)