Skip to content

teacher-coder/picture-muvie

Repository files navigation

Contributors

PicMuvie(Music Video)

초등학교에서 그림 뮤비 제작을 돕는 사이트입니다
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. Quick Start
  2. About The Project
  3. Getting Started
  4. Usage
  5. Roadmap
  6. Reference

Quick Start

1. Clone the repo

git clone https://github.com/techer-coder/picture-muvie.git

2. Run project

docker-compose -f docker-compose.dev.yml up --build

About The Project

유튜브를 보면 학생들의 그림 뮤비 영상이 많이 올라와 있습니다. 그런데 막상 우리 반을 위해 뮤비를 만드려고 하면 노래 가사 문서 만드는 것부터 큰 관문입니다. 다음과 같은 문제를 차례로 겪게 됩니다.

  1. 가사를 소절별로 문서 각 페이지마다 붙여넣기를 해서 만들어야 합니다. 학생 수가 25명이니 25페이지네?
  2. 운이 좋게 다른 선생님들이 작업하신 파일을 구했습니다. 가사가 15 페이지만 있네요? 우리반은 25명인데...

문서 작업에 시간이 오래 걸리거나 학급 인원수에 맞지 않는 문제를 해결하기 위해서 프로젝트를 시작하게 되었습니다. 선생님들이 손쉽게 자신의 학급 수에 맞게 가사 파일을 만들 수 있도록 했습니다. 본 서비스는 다음과 같은 단계로 진행됩니다.

  1. 노래 제목과 가수를 입력하여 가사를 검색합니다
  2. 가사 줄의 개수는 학급 인원 수를 나타냅니다. 학급 인원 수에 맞게 줄을 수정합니다
  3. 문서 파일을 다운로드 받습니다

screenshot 1

(back to top)

Built With

  • Vue
  • Django
  • PostgreSQL
  • Nginx

(back to top)

Getting Started

Prerequisites

  • python

    brew install python
  • poetry

    brew install poetry
  • npm

    brew install npm@latest -g
  • docker

    brew install docker

Docker

1-1. In Development Mode

  1. Build docker images & Run containers (!check execute cmd in 'root' directory)

    docker-compose -f docker-compose.dev.yml up --build
  2. Run containers by using existing one

    docker-compose -f docker-compose.dev.yml up
  3. Run docker in demon mode

    docker-compose -f docker-compose.dev.yml up -d
  4. Check docker images are set

    docker images
  5. Check docker containers are running well

    docker ps -a
  6. Inspect docker containers (!check docker containers still running)

    docker exec -it <container_names> <shell.dir>
    # docker exec -it frontend sh
    # docker exec -it db bin/bash/

(back to top)

Usage

1. 가사 검색

picture 2

2. 한글 또는 word로 다운로드

picture 3

3. 가사 소절별로 각 페이지 나뉜 문서 확인

picture 4

(back to top)

Roadmap

  • 학급 인원 수 30명을 기본으로 가사 제공
  • 가사 이미지 업로드 후 영상 편집 기능

See the open issues for a full list of proposed features (and known issues).

(back to top)

Reference

poetry 패키지 관리 방법

commit message conventions

(back to top)