# threedr-viewer

> 3DR Viewer: panorama rendering library and demo web page

Latest version **0.1.0** (published 2024-03-25) · 0 weekly downloads

## Install

```sh
npm install threedr-viewer
pnpm add threedr-viewer
yarn add threedr-viewer
bun add threedr-viewer
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2024-03-25 |
| First published | 2024-03-25 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 40.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | soyoung-park |
| Keywords | threejs |

## Links

- npm: https://www.npmjs.com/package/threedr-viewer
- Repository: https://es.naverlabs.com/OLM/ThreedrViewer
- npm.io page: https://npm.io/package/threedr-viewer

## Dependencies (3)

- [three](https://npm.io/package/three.md) ^0.152.2
- [lru-cache](https://npm.io/package/lru-cache.md) ^7.18.3
- [@types/three](https://npm.io/package/@types/three.md) ^0.152.1

## Recent versions

- 0.1.0 (latest) — 2024-03-25

## README

# 3dr-viewer-demo
Panorama demo viewer for 3DR project

## Authors
- 박소영 p.soyoung@naverlabs.com

## Development Environment
- `npm`
- `node@19.4.0`
- `protoc` (protocol buffer compiler)
    - MacOS:
        ```console
        $ brew install protobuf
        $ protoc --version
        ```
    - Linux:
        ```console
        $ sudo apt install protobuf-compiler
        $ protoc --version
        ```
    - 원래는 `npm install --save-dev protoc` 으로 설치하려 했는데, \
      M1 Mac에서 실행이 안되는 이슈가 있어서, 부득이하게 시스템에 protobuf 설치하도록 함.

## Build
- Build distribution files:
    ```console
    $ npm install
    $ npm run build
    ```
    - Then distribute all files in `dist/` directory:
        ```
        dist/
        |- threedr-viewer.js
        ```
- Test a sample and demo page in your local environment:
    - Open python server:
        ```console
        $ python -m http.server <port-number>
        ```
        Then open `http://localhost:<port-number>/demo/`.
    - Or open with rollup:
        ```console
        $ npm run test
        ```
        Then open `http://localhost:9004/demo/`.
- Clean `dist/` directory:
    ```console
    $ npm run clean
    ```

---
_Source: https://npm.io/package/threedr-viewer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
