Skip to content

Commit

Permalink
Move old readme.md to installation and update readme.md for project i…
Browse files Browse the repository at this point in the history
…ntroduction
  • Loading branch information
mk-pspace committed Oct 25, 2022
1 parent 4d193ce commit 0fa0afc
Show file tree
Hide file tree
Showing 11 changed files with 108 additions and 61 deletions.
61 changes: 61 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Poly

This is main repository for Poly, the model sharing platform.

## Dependancy

Poly server is dependant on AWS S3 and MySQL.

## Build server

To build you Poly Server, perform the following steps.

- Clone repository and install node packages
- Prepare S3Server for Poly server
- Create OAuth ID from Google and Github
- Update .env file
- Run Poly Server

### Cloning repository

To clone Poly repository, execute the commands below.

```bash
$ git clone --depth=1 https://github.com/parallelspaceRE/poly-web
$ cd poly-web
$ npm install
```

### Preparing S3Server

Using AWS S3 may be charged under AWS policy.

Create new S3 Bucket for Poly server.

### Creating OAuth ID

Following steps are guides for server which domain name is **poly-web.com**

If you don't have domain and want to run server for test, you can replace domain name to **http://localhost:3000**.

#### Google

Create OAuth 2.0 Client ID from [Google Cloud console](https://console.cloud.google.com/apis/credentials)

- Click _Create Credentials_ -> OAuth client ID
- Selecet _Web application_
- Fill **https://poly-web.com** for Authorized JavaScript origins
- Fill **https://poly-web.com/api/auth/callback/google** for Authorized redirect URIs
- Click _Create_ Button
- Memo your client id and Secret

#### Github

Create OAuth ID from [Github Developer settings](https://github.com/settings/developers)

- Click _New OAuth App_
- Fill App name
- Fill **https://poly-web.com** for Homepage URL
- Fill **https://poly-web.com/api/auth/callback/github** for Authorized callback URIs
- Click _Register application_
- Click _Generate a new client secret_ then memo the secret and Client ID
108 changes: 47 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,47 @@
# Poly

This is main repository for Poly, the model sharing platform.

## Dependancy

Poly server is dependant on AWS S3 and MySQL.

## Build server

To build you Poly Server, perform the following steps.

- Clone repository and install node packages
- Prepare S3Server for Poly server
- Create OAuth ID from Google and Github
- Update .env file
- Run Poly Server

### Cloning repository

To clone Poly repository, execute the commands below.

```bash
$ git clone --depth=1 https://github.com/parallelspaceRE/poly-web
$ cd poly-web
$ npm install
```

### Preparing S3Server

Using AWS S3 may be charged under AWS policy.

Create new S3 Bucket for Poly server.

### Creating OAuth ID

Following steps are guides for server which domain name is **poly-web.com**

If you don't have domain and want to run server for test, you can replace domain name to **http://localhost:3000**.

#### Google

Create OAuth 2.0 Client ID from [Google Cloud console](https://console.cloud.google.com/apis/credentials)

- Click _Create Credentials_ -> OAuth client ID
- Selecet _Web application_
- Fill **https://poly-web.com** for Authorized JavaScript origins
- Fill **https://poly-web.com/api/auth/callback/google** for Authorized redirect URIs
- Click _Create_ Button
- Memo your client id and Secret

#### Github

Create OAuth ID from [Github Developer settings](https://github.com/settings/developers)

- Click _New OAuth App_
- Fill App name
- Fill **https://poly-web.com** for Homepage URL
- Fill **https://poly-web.com/api/auth/callback/github** for Authorized callback URIs
- Click _Register application_
- Click _Generate a new client secret_ then memo the secret and Client ID
# Poly-Web 실감 뷰어 플랫폼

## 개발 동기
공공 데이터 혹은 CC0 라이선스인 3D 모델들을 수집 및 재구성하여 PC 웹브라우저와 모바일폰에서 쉽게 볼 수 있는 가능한 3D 뷰어 및 AR 뷰어 플랫폼을 개발하고자 합니다.
<br><br>

## 서비스 장점
- 앱을 설치하지 않아도, 모바일 웹으로 3D와 AR을 이용할 수 있습니다.
- 관광, 교육, 쇼핑 등에서 실물 오브젝트를 보기위해 현장을 방문하기 불편한 경우가 있기 때문에 3D 보기와 AR 가상 배치로 이러한 어려움을 보완할 수 있습니다.
<br><br>

## 플랫폼 구성
1. 메인 화면은 모델 오브젝트의 리스트로 구성되어 있습니다.
2. 오브젝트를 선택해 들어가면 3D 모델과 설명을 볼 수 있습니다.
3. 또한 AR로 보기 기능으로 실감나게 체험하듯이 볼 수 있습니다.

<p align="left"><img src="./imgs/demo_mainpage.jpg" width="90%">
<img src="./imgs/demo_viewerpage.jpg" width="90%">

</p>
<br>
<br>

## 시범 콘텐츠 AR 뷰어 웹페이지
- 해치 석상 (우리나라 문화유산 공공데이터) <br>
[3D 콘텐츠 데모 링크](https://www.k-heritage.xyz/models/8662da3f-333f-4646-a67f-a604c28b8d52)

<p align="left">
<img src="./imgs/demo1_3d_view0.jpg" width="30%" style="border-image: url('./imgs/demo1_3d_view0.jpg') 1px lightgray;">
<img src="./imgs/demo1_ar_view0.jpg" width="30%"style="border-image: url('./imgs/demo2_ar_view1.jpg') 1px lightgray;">
<img src="./imgs/demo1_QRCodeImg.jpg" width="30%">
<br>
<br>

- 도기 기마인물형 뿔잔 (우리나라 문화유산 공공데이터) <br>
[3D 콘텐츠 데모 링크](https://www.k-heritage.xyz/models/9c2c3e89-53d6-453b-a5f3-fa164f2d5609)

<p align="left"><img src="./imgs/demo2_3d_view0.jpg" width="30%">
<img src="./imgs/demo2_ar_view0.jpg" width="30%">
<img src="./imgs/demo2_QRCodeImg.jpg" width="30%">
</p>
<br>


## 별도의 플랫폼을 개설해 이용하고 싶은 경우
* 본 프로젝트 소스코드를 이용하여 별도의 공공 3D 모델 플랫폼을 자체 개설할 수 있습니다.
* 설치는 INSTALLATION.md를 참고 바랍니다. S3, AWS 등의 셋팅이 필요합니다.
Binary file added imgs/demo0_mainpage.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo1_3d_view0.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo1_QRCodeImg.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo1_ar_view0.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo2_3d_view0.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo2_QRCodeImg.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo2_ar_view0.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo_mainpage.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/demo_viewerpage.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0fa0afc

Please sign in to comment.