https://github.com/nurodev/deno-module

🦕 Template repository to help bootstrap a new Deno module
https://github.com/nurodev/deno-module

deno denoland portfolio template template-project template-repository typescript

Last synced: 2 months ago
JSON representation

🦕 Template repository to help bootstrap a new Deno module

• Host: GitHub
• URL: https://github.com/nurodev/deno-module
• Owner: NuroDev
• License: mit
• Created: 2022-04-26T12:49:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-27T18:01:06.000Z (about 2 years ago)
• Last Synced: 2024-10-06T08:41:37.792Z (8 months ago)
• Topics: deno, denoland, portfolio, template, template-project, template-repository, typescript
• Language: TypeScript
• Homepage:
• Size: 18.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


    


    


    🦕

    


    deno-module

    


    


    


    


  

  

    


    Template project to build a new Deno module

    


    


[![License](https://img.shields.io/badge/-License-blue.svg?style=for-the-badge)](https://github.com/nurodev/deno-module)

[![Build](https://img.shields.io/github/actions/workflow/status/nurodev/deno-module/CI?label=%20&logo=github&logoColor=white&style=for-the-badge)](https://github.com/nurodev/deno-module/actions/workflows/ci.yml)

[![Docs](https://img.shields.io/badge/-Docs-blueviolet.svg?style=for-the-badge)](https://doc.deno.land/https://deno.land/x/deno-module/mod.ts)



  


  




## 🚀 Install

To get started you will first need to install [Deno](http://deno.land/). View

their website on [how to install Deno](https://deno.land/#installation)

You can either import the module directly via an `import` or add it to your import map, preferraly inside of your `deno.json`

**(Recommended)**:

```json

{

  "imports": {

    "deno-module/": "https://deno.land/x/deno-module/"

  }

}

```

## 🦄 Usage

```typescript

import { ... } from "deno-module/mod.ts";

// ...

```

## ☁️ Deploying

To set up a automatic publishing of your Deno module, you'll need to set up a

GitHub webhook.

```

https://api.deno.land/webhook/gh/

```

I recommend reading through

[this blog post](https://dev.to/craigmorten/how-to-publish-deno-modules-2cg6)

that outlines each step needed to do this.