Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kminji127 committed Mar 23, 2024
1 parent 1d8c00a commit da1f213
Showing 1 changed file with 32 additions and 58 deletions.
90 changes: 32 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,47 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
</p>

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->

## Description

[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.

## Installation
![github-title](https://github.com/2023-Marble/Marble-Server/assets/61882016/767380ee-7428-467a-b960-099e64dca0bd)

```bash
$ npm install
```
<br />

## Running the app
## 🔮 서비스 소개

```bash
# development
$ npm run start
> 다른 사람의 브이로그나 타입랩스에 내 얼굴이 찍혀서 불쾌했던 경험이 있나요?
# watch mode
$ npm run start:dev
**Marble**은 사전에 등록한 얼굴 이외의 다른 인물을 동영상에서 실시간, 자동으로 모자이크하는 서비스입니다.

# production mode
$ npm run start:prod
```
Marble의 주요 기능은 다음과 같습니다.

## Test
1. 실시간 자동 모자이크
- 동영상 촬영 중 실시간으로 얼굴을 인식해 모자이크 처리
2. 얼굴 사전 등록
- 구글 소셜 로그인을 통해 모자이크하지 않을 얼굴 등록
3. 모자이크 옵션 설정
- 기본 (모자이크)
- 블러
- 표정 마스킹 (웃는 얼굴 or 무표정)
- 커스텀 스티커 (사용자가 업로드한 이미지 파일)

```bash
# unit tests
$ npm run test
## 🔮 아키텍처

# e2e tests
$ npm run test:e2e
![Architecture](https://github.com/2023-Marble/Marble-Server/assets/61882016/842d1e2b-27cb-49c4-ae71-2bf0a6ceb3f8)

# test coverage
$ npm run test:cov
```
## 🔮 서비스 파이프라인

## Support
![파이프라인_얼굴등록](https://github.com/2023-Marble/Marble-Server/assets/61882016/fdd37406-c32d-46cd-a65a-31f7522e8d22)

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
![파이프라인_얼굴detection](https://github.com/2023-Marble/Marble-Server/assets/61882016/a5f92ff6-7ef0-4eef-ba87-d3913aa39614)

## Stay in touch
## 🔮 Running the app

- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
```bash
# installation
$ npm install

## License
# development
$ npm run start

Nest is [MIT licensed](LICENSE).
# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

0 comments on commit da1f213

Please sign in to comment.