💰 돈이머니(Money is Money)

#️⃣ 프로젝트 소개

본 서비스는 사용자들이 개인 재무를 관리하고 지출을 추적하는 데 도움을 줍니다. 또한 사용자들이 예산을 설정하고 지출을 모니터링하며 재무 목표를 달성하는 데 도움을 주도록 REST API로 구현한 예산 관리 어플리케이션입니다.

🛠️ 기술 스택

     
     

🏷️ 목차

1. ⚙️ 환경 설정 및 실행
2. 💿 데이터베이스 모델링
3. 🌏 API 명세
4. 📑 구현 내용
5. 🏢 원티드 프리온보딩 백엔드 인턴십 - TEAM E

⚙️ 환경 설정 및 실행

데이터베이스 스키마를 생성합니다.

CREATE DATABASE `wanted`
    DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

서버 및 데이터베이스 연결을 위한 환경 변수를 설정합니다.

SERVER_PORT=
DB_PORT=
DB_USERNAME=
DB_PASSWORD=
DB_DATABASE=
JWT_SECRET=
EMAIL_USERNAME=
EMAIL_PASSWORD=

데이터베이스 스키마 생성 후, 스크립트 파일 실행으로 초기 설정합니다.

> sh start.sh # 리눅스 스크립트 파일 실행
> ./start.bat # 윈도우 스크립트 파일 실행

💿 데이터베이스 모델링

🌏 API 명세

GitHub Wiki로 이동! 🏃🏻‍💨

📑 구현 내용

사용자

• 계정명, 이메일, 비밀번호를 사용하여 회원가입하고, bcrypt로 비밀번호를 암호화합니다.
• Cookie와 JWT 기반으로 인증합니다.
• 로그인 이후 모든 API 요청에 대해 JWT 유효성을 검증합니다.
• 인증된 사용자는 사용자의 정보를 조회할 수 있습니다.

카테고리

• 스크립트 파일을 통해 기본적인 카테고리 목록이 추가 됩니다.
• 카테고리 초기 데이터

id	type
1	식비
2	주거비
3	교통비
4	의류
5	문화 및 여가
6	의료 및 건강
7	교육
8	기타

• 사용자가 예산 설정에 사용할 수 있는 모든 카테고리 목록을 조회할 수 있습니다.

예산

• 매 월마다 예산을 설정합니다.
• 예산은 카테고리를 필수로 지정하여, 카테고리 별 예산을 추가합니다.
• 총 예산을 입력하고, 예산 추천을 받을 시 사용자 총 예산과 근접한 다른 사용자 10명의 카테고리 별 예산 목록을 가져옵니다.

요구사항 변경

• 초기 요구사항
  
• 요구사항 변경 내용 및 사유
  • 기존 이용 중인 사용자들이 설정한 평균 비율 값이 사용자가 원하는 예산 설계에 적절하지 않을 수 있다고 생각함
    • ex) 기존 사용자들와 사용자간의 예산 격차가 큼
    • ex) 추천대로 예산 비율을 받았으나, 사용자의 지출 취향을 고려받는다는 보장이 없음
  • 사용자 총 예산과 근접한 다른 사용자 10명의 카테고리 별 예산 목록을 가져오는 것이 좀 더 참고하기 좋다고 판단
    • 추후 적절한 지출 여부를 추가해 예산 설계 추천의 정확성을 높여도 괜찮다고 생각

지출

• 지출 API는 생성한 사용자만 권한을 갖습니다.
• 지출 일시, 지출 금액, 지출 거래처, 카테고리 와 지출 내용을 입력하여 지출 정보를 추가하거나 변경합니다.
• 지출 목록을 조회합니다.
  • 필수적으로 시작 기간과 끝 기간을 입력 받습니다.
  • 조회된 모든 내용의 지출 합계, 카테고리 별 지출 합계를 같이 반환합니다.
  • 특정 카테고리만으로 지출 목록을 조회할 수 있습니다.
  • 최소, 최대 금액으로 지출 목록을 조회할 수 있습니다.
• 지출 정보에 합계 제외를 설정할 수 있음
  • 지출 목록에는 포함되지만, 지출 합계에서는 제외
• 오늘 지출 추천을 조회할 수 있습니다.
  • 설정한 월별 예산을 만족하기 위해 오늘 지출 가능한 금액을 총액과 카테고리 별 금액으로 조회합니다.
    • 앞선 일자에서 소비한 만큼 이후 일자에 부담을 분배
    • 기간 전체 예산을 초과 하더라도 0원 또는 음수 의 예산을 추천받지 않아야 함
      • 지속적인 소비 습관을 생성하기 위한 서비스이므로 예산을 초과하더라도 최소 하루 추천 지출 금액을 추천
    • 지출 상황에 맞는 멘트 노출
      • 추천 지출을 지킬 경우: 절약을 잘 실천하고 계세요! 오늘도 절약 도전!
      • 추천 지출을 초과할 경우: 추천 지출 금액을 초과하였어요. 절약해주세요!
    • 100원원 단위로 추천 지출 금액을 내림하여 추천 지출 금액 설정
• 오늘 지출 안내를 조회할 수 있습니다.
  • 오늘 지출한 내용을 총액 과 카테고리 별 금액을 조회
  • 월별설정한 예산 기준 카테고리 별 통계 제공
    • 일자 기준 오늘 적정 금액: 오늘 기준 사용했으면 적절했을 금액
    • 일자 기준 오늘 지출 금액: 오늘 기준 사용한 금액
    • 위험도: 카테고리 별 적정 금액, 지출금액의 차이를 위험도로 나타내며 단위는 % 입니다.
      • 추천 금액 10,000원, 사용한 금액 20,000원이면 위험도 200%

자동화

• Cron 스케줄링을 통해 자동화가 진행됩니다.

• 매일 08:00시

  • isRecommendNotified를 true로 설정한 사용자들에 이메일 전송
    

• 매일 20:00시

  • isExpenseNotified를 true로 설정할 사용자들에 이메일 전송
    

🏢 원티드 프리온보딩 백엔드 인턴십 - TEAM E

Gibhub Organization으로 이동 😊