https://github.com/nextcss/template-module
Template for nextcss modules
https://github.com/nextcss/template-module
actions codecov jest npm rollup template yarn
Last synced: 27 days ago
JSON representation
Template for nextcss modules
- Host: GitHub
- URL: https://github.com/nextcss/template-module
- Owner: nextcss
- License: mit
- Created: 2022-12-06T07:37:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-28T17:00:53.000Z (about 3 years ago)
- Last Synced: 2025-02-15T00:42:25.042Z (12 months ago)
- Topics: actions, codecov, jest, npm, rollup, template, yarn
- Language: JavaScript
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Getting Started
- Click to `Use this template` button
- Update `LICENSE` file
- Update `README` file
- Update `package.json` file
- Start coding in `src/` folder
- Add tests in `test/` folder
- Workflow uses Codecov
---
[Place badges here]
# Title
[Short description]
- [Introduction](#introduction)
- [Installation](#installation)
- [TypeScript](#typeScript)
- [Guidelines](#guidelines)
- [License](#license)
## Introduction
[What is this package]
## Installation
Install the package via yarn or npm.
```bash
yarn add @nextcss/{PACKAGE}
```
```bash
npm i @nextcss/{PACKAGE}
```
## Other Sections
[Write sections here. Don't forget to add links to the Table of Contents']
## TypeScript
Since we don't use TypeScript, any issue with TypeScript is your business. For more information, see
the Typescript documentation. If you're having problems with TypeScript, here are some hints that
might get you started:
- `esModuleInterop` option in `compilerOptions`
- `allowJs` option in `compilerOptions`
- `declare module "*"` definition in `declarations.d.ts`
## Guidelines
To learn about the guidelines, please read the [Code of Conduct](https://github.com/nextcss/.github/blob/main/CODE_OF_CONDUCT.md), [Contributing](https://github.com/nextcss/.github/blob/main/CONTRIBUTING.md) and [Security Policy](https://github.com/nextcss/template-module/security/policy) documents.
## License
MIT License @ {YEAR} [Zsolt Tövis](https://github.com/toviszsolt)
If you found this project interesting, please consider supporting my open source work by [sponsoring me](https://github.com/sponsors/toviszsolt) / [give the repo a star](https://github.com/nextcss/template-module) / [follow the nextcss project](https://github.com/nextcss).