qrcode-decoder - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #golang #go #machine-learning #deep-learning #docker #java #security #mcp

qrcode-decoder

(★ 104)

🤘Tool for decoding qrcode by image,video or camera.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- ISSUE_TEMPLATE
- index.test.ts
- - duck.jpg
  - qrcode-video.mp4
  - qrcode.png
- - vconsole.min.js
- camera.html
- image.html
- index.html
- video.html
- api.md
- api.zh-CN.md
- bundle.ts
- logger.ts
- tsconfig.json
- index.ts
.babelrc
.editorconfig
.gitignore
.npmignore
.npmrc
.prettierignore
.prettierrc
jest.config.js
LICENSE
package.json
pnpm-lock.yaml
README.md
README.zh-CN.md
TODO.md
tsconfig.json
tslint.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/yugasun/qrcode-decoder

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd qrcode-decoder

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

$ pnpm install --save qrcode-decoder

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

$ pnpm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

$ pnpm run build

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

$ pnpm test

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ pnpm run release

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [qrcode-decoder](https://github.com/yugasun/qrcode-decoder)

[![npm](https://img.shields.io/npm/v/qrcode-decoder)](http://www.npmtrends.com/qrcode-decoder)
[![NPM downloads](http://img.shields.io/npm/dm/qrcode-decoder.svg?style=flat-square)](http://www.npmtrends.com/qrcode-decoder)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yugasun/qrcode-decoder/blob/master/LICENSE)

[简体中文](./README.zh-CN.md) | English

A tool for decoding qrcode.

## Directory

```
.
├── demo            code demo
├── dist            build output
├── doc             docs
├── src             source code
├── test            unit test
├── CHANGELOG.md    change log
└── TODO.md         todo list
```

## Guide

Use `pnpm` to install.

```bash
$ pnpm install --save qrcode-decoder
```

Using in webpack:

```js
import QrcodeDecoder from 'qrcode-decoder';
```

Using in browser:

```html
<script src="https://unpkg.com/qrcode-decoder@0.3.1/dist/index.min.js"></script>
```

## Demo

### QrcodeDecoder()

User `new` to create a decoder object.

```javascript
var qr = new QrcodeDecoder();
```

#### decodeFromImage(img, options)

Decodes an image from url or an `<img>` element with a `src` attribute set.

```javascript
qr.decodeFromImage(img).then((res) => {
  console.log(res);
});
```

[Demo](./demo/image.html)

#### decodeFromVideo(videoElem, options)

Decodes directly from a video with a well specified `src` attribute

```javascript
qr.decodeFromVideo(videoElement).then((res) => {
  console.log(res);
});
```

[Demo](./demo/video.html)

#### decodeFromCamera(videoElem, options)

Decodes from a videoElement.

```javascript
qr.decodeFromCamera(videoElem).then((res) => {
  console.log(res);
});
```

[Demo](./demo/camera.html)

#### stop()

Stops the current `qr` from searching for a QRCode.

## Develop

Install dependencies:

```bash
$ pnpm install
```

Build code:

```bash
$ pnpm run build
```

Run unit test:

```bash
$ pnpm test
```

Modify version in `package.json`, run `release` script:

```bash
$ pnpm run release
```

Publish

```bash
$ pnpm publish
```

## License

[MIT](./LICENSE)