Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/create-node-app/cna-templates
This repository contains templates and extensions for the https://www.npmjs.com/package/create-awesome-node-app package.
https://github.com/create-node-app/cna-templates
create-awesome-node-app devcontainer docker docker-compose github-actions hacktoberfest nestjs reactjs typescript
Last synced: about 2 months ago
JSON representation
This repository contains templates and extensions for the https://www.npmjs.com/package/create-awesome-node-app package.
- Host: GitHub
- URL: https://github.com/create-node-app/cna-templates
- Owner: Create-Node-App
- License: mit
- Created: 2020-09-27T04:31:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T05:40:09.000Z (7 months ago)
- Last Synced: 2024-06-17T06:44:50.449Z (7 months ago)
- Topics: create-awesome-node-app, devcontainer, docker, docker-compose, github-actions, hacktoberfest, nestjs, reactjs, typescript
- Language: Less
- Homepage:
- Size: 2.06 MB
- Stars: 7
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cna Templates
This repository contains templates and extensions for the package.
## How to add new templates or extensions?
1. Fork this repository
2. Add your template or extension to the `templates` or `extensions` folder respectively (see below for more details)
3. Add your template or extension to the `templates.json` in the `templates` or `extensions` property respectively with the following format:
```json
{
"name": "template-name",
"description": "Template description",
"url": "https://github.com/username/repository/tree/branch/path/to/template",
"type": "template_type",
"category": "template_category",
"labels": ["template", "labels"]
}
```
Check the [template properties](#template-properties) section for more details.
4. Create a pull request!
### Template Properties
| Property | Description | Type |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **name** | The name of the template or extension | `string` |
| **description** | A short description of the template or extension | `string` |
| **url** | The URL to the template or extension. For example, if you want to use a template from a GitHub repository, you can use the following format: `https://github.com/username/repository/tree/branch/path/to/template` | `string` |
| **type** | The type of the template or extension. Can be any value that will be used to group templates and extensions. For example, if you want to add a new template and five extensions related to it, you can use the same type for all of them. | `string` |
| **category** | The category of the template or extension. Can be any value that will be used to group templates and extensions. | `string` |
| **labels** | An array of labels that will be used to filter templates and extensions. | `string[]` |