Skip to content

Fusili23/tinyURL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Is available at: https://lorc.my/ <- Try this (I turn off the server when I'm sad)

TinyURL

긴 URL을 짧은 단축 URL로 변환해주는 서비스

기능 소개 (Features)

  • URL 단축: 긴 URL을 입력하면 짧은 고유 코드를 생성
  • 리다이렉트: 단축된 URL로 접속 시 원래의 원본 URL로 이동
  • API 기반: RESTful API

시작 가이드 (Getting Started)

이 프로젝트를 로컬 환경에서 실행하기 위해 다음 단계들을 따라주세요.

1. 사전 요구사항 (Prerequisites)

  • Node.js (v14 이상 권장)
  • MongoDB (로컬 설치 또는 Atlas 클라우드 계정)

2. 저장소 클론 (Clone Repository)

git clone [https://github.com/YOUR_GITHUB_USERNAME/YOUR_REPOSITORY_NAME.git](https://github.com/YOUR_GITHUB_USERNAME/YOUR_REPOSITORY_NAME.git)
cd YOUR_REPOSITORY_NAME

4. 환경 변수 설정 (Environment Variables) - 중요!

이 프로젝트는 보안을 위해 .env 파일을 저장소에 올리지 않았습니다. 프로젝트 루트 경로에 .env 파일을 직접 만들고, 아래 설명을 참고하여 본인의 환경에 맞는 값을 채워 넣어야 작동합니다.

4-1. 설정 방법

  1. 프로젝트 최상위 폴더에 .env 파일을 생성합니다.
  2. 아래 내용을 복사해서 붙여넣습니다.
  3. (아래 항목들의 변수 값들은 모두 예시입니다)
PORT=5000
BASE_URL=http://localhost:5000
MONGO_URI=mongodb://localhost:27017/tinyurl

4-2. 각 변수 값 구하는 법 (상세 가이드)

PORT: 서버가 실행될 포트 번호입니다. 기본값으로 5000을 사용하면 됩니다. (다른 프로그램과 충돌 시 3000, 8080 등으로 변경 가능)

BASE_URL: 단축된 URL의 앞부분에 붙을 기본 주소입니다.

MONGO_URI: (가장 중요) MongoDB 데이터베이스 접속 주소입니다.

  • 방법 A: 내 컴퓨터에 MongoDB가 설치된 경우 (로컬)
    • 주소 형식: mongodb://localhost:27017/데이터베이스이름
    • 예시: mongodb://localhost:27017/tinyurl (별도 설정 없이 바로 사용 가능)
  • 방법 B: MongoDB Atlas (클라우드) 사용하는 경우
    • MongoDB Atlas 접속 및 로그인
    • Cluster에서 Connect 버튼 클릭 -> Connect your application 선택
    • 제공되는 주소를 복사 (예: mongodb+srv://username:password@...)
    • username과 password 부분을 본인의 DB 계정 아이디/비밀번호로 변경하여 입력

About

How to develop and deploy

Topics

Resources

Stars

Watchers

Forks

Contributors