Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cham11ng/ts-package-starter
A simple boilerplate starter kit for express api in typescript
https://github.com/cham11ng/ts-package-starter
bun hacktoberfest husky starter typescript
Last synced: about 2 months ago
JSON representation
A simple boilerplate starter kit for express api in typescript
- Host: GitHub
- URL: https://github.com/cham11ng/ts-package-starter
- Owner: cham11ng
- Created: 2017-12-29T10:21:50.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T17:50:03.000Z (over 1 year ago)
- Last Synced: 2024-10-30T23:13:04.503Z (3 months ago)
- Topics: bun, hacktoberfest, husky, starter, typescript
- Language: TypeScript
- Homepage:
- Size: 228 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @cham11ng/ts-package-starter
Mono-repo collection of utils, library, common and interfaces.
## Setup
1. Generate a GitHub access token with `read:packages` and `write:packages` access.
2. Log in to `npm` with your **GitHub account username** in `Username` and the **generated github access token** in `Password` .
```bash
$ npm login --registry https://npm.pkg.github.com
Username:
Password:
Email: (this IS public)
Logged in as on https://npm.pkg.github.com/.
```
3. :tada: You can now fetch packages from GitHub Registry.
## Usage
To use packages from the private GitHub registry in your repository.
1. Create `.npmrc` file with scope and registry mapping.
```
@cham11ng:registry=https://npm.pkg.github.com
```
2. Install the package
```
yarn add @cham11ng/ts-package-starter
```
## Installation
```sh
bun install
```
## Publish
```sh
yarn publish
```