https://github.com/denorg/clipboardy

Cross-platform util to copy/paste
https://github.com/denorg/clipboardy

Last synced: 7 months ago
JSON representation

Cross-platform util to copy/paste

• Host: GitHub
• URL: https://github.com/denorg/clipboardy
• Owner: denorg
• License: mit
• Created: 2020-07-24T07:18:23.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-24T07:18:25.000Z (almost 6 years ago)
• Last Synced: 2025-02-16T10:46:50.693Z (over 1 year ago)
• Language: TypeScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🏁 Deno Starter

This is a starter template for building Deno packages in TypeScript, with GitHub Actions-powered CI, tests, CLI, and Semantic Release on GitHub and npm.

[![Deno CI](https://github.com/denorg/starter/workflows/Deno%20CI/badge.svg)](https://github.com/denorg/starter/actions)

[![GitHub](https://img.shields.io/github/license/denorg/starter)](https://github.com/denorg/starter/blob/master/LICENSE)

[![Contributors](https://img.shields.io/github/contributors/denorg/starter)](https://github.com/denorg/starter/graphs/contributors)

[![Deno Starter](https://img.shields.io/badge/deno-starter-brightgreen)](https://denorg.github.io/starter/)

[![Made by Denorg](https://img.shields.io/badge/made%20by-denorg-0082fb)](https://github.com/denorg)

[![TypeScript](https://img.shields.io/badge/types-TypeScript-blue)](https://github.com/denorg/starter)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## 💡 How to use

1. [Create a new repository](https://github.com/denorg/starter/generate) using this template

2. Update the project name ("Deno Starter") from the first line in `README.md`

3. Find and replace "denorg/starter" with your "username/repository" in `README.md`

4. Update the "Getting started" guide with your exported functions' names

5. In `.github/workflows/*.yml` files, add additional permissions after `deno test`

6. Setup Semantic Release

  - Add a repository secret `NPM_TOKEN` with your npm token

  - In `.github/workflows/deno.yml`, find and replace "denorg/starter" with your "username/repository"

7. Remove this section ("How to use") after setting up your respoitory

If you're not building a Denorg project, the following steps are required too:

1. Remove the "A project by Denorg..." footer from `README.md`

2. Remove the "Made by Denorg" shield from the `README.md` badges section

3. Change the "Denorg" name to yours in `LICENSE` and under "License" in `README.md`

## ⭐ Getting started

Import the `mode` function and use it:

```ts

import { mode } from "https://raw.githubusercontent.com/denorg/starter/master/mod.ts";

const result = mode();

```

### CLI with [DPX](https://github.com/denorg/dpx)

After [installing DPX](https://github.com/denorg/dpx), you can directly use the CLI using the `dpx` command:

```bash

dpx --allow-read starter 

```

### CLI

Alternatively, you can use it directly from the CLI by using `deno run`:

```bash

deno run --allow-read https://raw.githubusercontent.com/denorg/starter/master/cli.ts 

```

You can also install it globally using the following:

```bash

deno install --allow-read -n starter https://raw.githubusercontent.com/denorg/starter/master/cli.ts

```

Then, the package is available to run:

```bash

starter 

```

### Configuration

Required permissions:

1. `--allow-read`

## 👩‍💻 Development

Run tests:

```bash

deno test --allow-read

```

## 📄 License

MIT © [Denorg](https://den.org.in)



  

    

  





  A project by Denorg, the world's first Deno-focused community
organization and consulting company. Work with us →