Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denorg/starter
🏁 Deno starter repository with CI, releases, and more
https://github.com/denorg/starter
deno denoland denorg starter starter-kit typescript
Last synced: 1 day ago
JSON representation
🏁 Deno starter repository with CI, releases, and more
- Host: GitHub
- URL: https://github.com/denorg/starter
- Owner: denorg
- License: mit
- Created: 2020-05-14T22:40:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-30T11:03:30.000Z (over 4 years ago)
- Last Synced: 2024-04-27T05:37:16.756Z (7 months ago)
- Topics: deno, denoland, denorg, starter, starter-kit, typescript
- Language: TypeScript
- Homepage: https://denorg.github.io/starter/
- Size: 32.2 KB
- Stars: 27
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deno-cn - @denorg/starter
- awesome-deno - starter - Deno module starter template with GitHub Actions CI. (Tools / Online Playgrounds)
- awesome-deno - starter - Deno module starter template with GitHub Actions CI (Tools / XML)
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.
[](https://github.com/denorg/starter/actions)
[](https://github.com/denorg/starter/blob/master/LICENSE)
[](https://github.com/denorg/starter/graphs/contributors)
[](https://denorg.github.io/starter/)
[](https://github.com/denorg)
[](https://github.com/denorg/starter)
[](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 →