https://github.com/somnisomni/mollufier
입?력한 문?장을 몰?루화합니다.
https://github.com/somnisomni/mollufier
blue-archive bluearchive kiwi kiwipiepy python vue
Last synced: 6 months ago
JSON representation
입?력한 문?장을 몰?루화합니다.
- Host: GitHub
- URL: https://github.com/somnisomni/mollufier
- Owner: somnisomni
- License: mit
- Created: 2021-11-13T08:58:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-02T08:42:55.000Z (over 1 year ago)
- Last Synced: 2024-05-02T01:24:24.274Z (about 1 year ago)
- Topics: blue-archive, bluearchive, kiwi, kiwipiepy, python, vue
- Language: Vue
- Homepage: https://mollufier.koharu.dev
- Size: 4.49 MB
- Stars: 24
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
" 내가 몰?루가 될께... "
몰?루파이어
===========
소개
----
몰?루파이어 *(Mollufier, **몰↗?루↘파이어**처럼 발음합니다)*는 사용자가 입력한 문장에서 형태소 분석기([Kiwi](https://github.com/bab2min/Kiwi))가 인식한 명사 사이에 물음표를 삽입해주는, 재미로 만든 토이 프로젝트입니다.
사용해보기
----------
몰?루파이어는 현재 제 개인 서버에서 배포하고 있습니다. [**여기를 클릭해 사용해보세요!**](https://mollufier.koharu.dev)
아이디어
--------
그런거 없으면 만들면 된다!
개발 서버 실행하기
------------------
```sh
# 백엔드
$ cd backend
$ pip3 install -r requirements.txt
$ python3 index.py
# 프론트엔드
$ cd frontend
$ yarn install
$ yarn serve
```
Docker로 배포하기
-----------------
[6d54e64](https://github.com/somnisomni/mollufier/commit/6d54e64defad66ab4af868b2003a83c17b5e8403) 커밋 이후로 Docker를 통해 간편히 앱을 배포(실행)할 수 있게 되었습니다.
Docker Hub 등 컨테이너 이미지 저장소에 업로드하지 않기 때문에 이미지를 직접 빌드하여 배포해야 합니다.
1. 몰?루파이어의 git 리포지토리를 clone 한 후, 리포지토리 루트에서 Docker 이미지를 빌드합니다.
```sh
$ docker build -t mollufier:latest \
--build-arg FE_PUBLIC_PATH="" \
--build-arg FE_BACKEND_BASE_URL=""
--build-arg FE_GA_MEASUREMENT_ID="" \ .
```
- **빌드 인수 `FE_PUBLIC_PATH`** : *(선택적, 기본값 `/`)* 앱의 프론트엔드가 배포되는 URL 주소의 루트 경로입니다.
프론트엔드 URL 루트가 도메인의 루트라면 기본값을 사용하면 됩니다. (ex. `https://example.com/`에 배포하는 경우)
하위 디렉토리에서 프론트엔드를 배포할 경우 도메인 루트부터 시작한 값으로 설정합니다. (ex. `https://example.com/mollufier`에 배포하는 경우 `/mollufier`로 인수 값 설정)
- **빌드 인수 `FE_BACKEND_BASE_URL`** : *(선택적, 기본값 `/api`)* 앱의 백엔드가 배포되는 URL입니다.
백엔드를 다른 URL 상에서 배포를 할 경우, 절대 또는 상대 경로의 URL을 값으로 설정합니다. (ex. `https://api.example.com/mollufier`에 배포하는 경우 그 URL을 그대로 인수 값 설정)
- **빌드 인수 `FE_GA_MEASUREMENT_ID`** : *(선택적, 기본값 공란)* Google Analytics 측정 ID입니다.
값을 지정하지 않거나 비어 있는 값을 지정할 경우 Google Analytics가 탑재되지 않습니다.
2. 이미지 빌드가 완료되면 컨테이너를 생성하여 실행합니다.
```sh
$ docker run -d \
-e FE_DEPLOY_HOST= \
-p :8080 \
-p :8081 \
--restart unless-stopped \
--name mollufier \
mollufier:latest
```
- **환경 변수 `FE_DEPLOY_HOST`** : *(선택적, 기본값 공란)* 앱의 프론트엔드가 배포되는 호스트(도메인)입니다.
이 환경 변수를 지정하면 백엔드의 CORS Origin이 지정한 값으로 한정됩니다. 지정하지 않은 경우 CORS Origin이 모든 도메인으로 설정됩니다.
프로토콜과 (프로토콜의 기본 포트가 아닌 경우) 포트가 포함된 값이 필요합니다. (ex. `https://example.com`, `http://testserver.local:3939`)
컨테이너 내부에서 프론트엔드는 포트 **8080**, 백엔드는 포트 **8081**로 실행됩니다. 포트 바인딩을 할 경우 이에 맞추어 바인딩하면 됩니다.
> ※ **주의!** 이 리포지토리의 Dockerfile로 빌드하는 경우, 몰?루파이어의 프론트엔드와 백엔드는 각각 간단한 웹 서버([http-server](https://www.npmjs.com/package/http-server) 및 [Flask](https://flask.palletsprojects.com/))를 통해 실행됩니다.
> 프로덕션으로 배포하기에는 보안에 취약할 가능성이 크기 때문에, [nginx](http://nginx.org/) 등 고급 웹 서버 소프트웨어에서 제공하는 [리버스 프록시](https://www.cloudflare.com/ko-kr/learning/cdn/glossary/reverse-proxy/)를 이용한 배포가 권장됩니다.
라이선스
--------
몰?루파이어는 [MIT 라이선스](LICENSE.md) 하에 오픈 소스로 공개하고 있습니다.
만든이 및 주의사항
------
**솜니 (somni)** / [트위터](https://twitter.com/somni_somni), [GitHub](https://github.com/somnisomni)
> ※ 본 서비스의 개발자 **솜니 (somni)** 는 사용자가 이 서비스를 이용함으로 인해 발생하는 모든 불이익과 분쟁에 대해 책임을 질 의무를 일절 갖지 않습니다.
>
> ※ 사용자가 본 서비스에 입력한 문장 등은 서버에 따로 명시적으로 저장하고 있진 않습니다. 단, 경찰 등 공공기관으로부터 수사 협조 요청이 발생할 경우 본 서비스 관련 로그 파일의 내용이 제공될 수 있습니다.