pingvin-share-x

(★ 359)

Pingvin Share X is a secure and easy self-hosted file sharing platform.

  • .dockerignore
  • .gitignore
  • AI_USAGE_POLICY.md
  • CHANGELOG.md
  • config.example.yaml
  • crowdin.yml
  • docker-compose.dev.yml
  • docker-compose.local.yml
  • docker-compose.yml
  • Dockerfile
  • eslint.config.mjs
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • SECURITY.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/smp46/pingvin-share-x

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd pingvin-share-x

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker compose pull

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

docker compose up -d

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
cd backend

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
// repository documentation