Lyckabc/ProWiki_B

private project but public to you

https://busy-apple-85c.notion.site/README_ProWikiQ-fbf6c549ae734f57a4fe8aa3cbc67e8f?pvs=4

📑

README_ProWikiQ

0. 개요 📜

1.기능 👾

2. 시나리오 (Ver 1.0) 📚

99. ERD

0. 개요 📜

Province Wiki Q- Encyclopedia

• Swagger같은 Project doc API

  지방관리들의 빠른 지령 백과사전

기술 구상도

개발환경

OS : Mac OS

IDE : IntelliJ

JAVA Version : JDK 11

SpringBoot Version : 2.6.16-SNAPSHOT

DataBase : PostgreSQL

Build Tool : Gradle 7.3

Gradle DSL : Kotlin

Manage Tool : GitHub

Git Client : Fork

API tool : Postman

Dependencies

Spring Data JPA

Spring Security

Swagger

Lombok

Spring Web

기술 스택

• Backend

  Framework : Spring Boot 2.6.16-SNAPSHOT

  Spring Data JPA

• DB

  PostgreSQL

• (Option)Frontend

1.기능 👾

계정

• 회원가입

  • 회원가입 시 prj 관리자로 User 생성. 개인 회원가입

  • (Option) Batch 다량 회원가입 계정 Test

• 로그인

  • 일반 로그인

  • (Option) sns, google, kakao, naver 기반 회원가입

    sns 계정으로 가입시 오프라인 사용하더라도 “Lo_”가 붙지 않음.

• 권한부여

  • (Option) 전체 관리자, 각 Prj 관리자, Prj별 팀장(팀 내 리더 팀원 추가구성 가능), Prj 팀원

    • 최고 권한(루트)을 가진 계정 레벨 시스템에는 각 프로젝트 관리자, 팀 관리자, 팀원이 있습니다.

    • 최고 권한(루트)은 각 프로젝트 관리자에게 권한을 부여할 수 있고, 프로젝트 관리자는 자신의 프로젝트의 각 팀 관리자에게 권한을 부여할 수 있습니다.

    • 관리자는 관리자와 팀원에게 권한을 부여할 수 있습니다. 권한을 받은 관리자는 상위 관리자가 허가한 파일에만 접근할 수 있습니다.

    • 팀원은 관리자의 허가를 받은 파일 위치에서만 파일에 접근할 수 있습니다

    • Prj ID By Account & 날짜,시간

      온라인 기반은 자유자재로 중복여부만 파악

      오프라인 (로컬) 기반은 “Lo_”이 앞으로 필히 들어감 (ID 값에도 온라인과 구분지을 ID 값이 들어감. 해당 계정을 온라인으로 바꿀 시

  • folder, file접근권한 (read,write)

• 조회

  전체조회 list

  특정인 조회 detail

• 제거

  전체 제거

  특정user 제거

• 요청

• (Option) count up down Category

  • 레벨 시스템을 가져서 각 계정이 경험치를 쌓아나가도록 부여

    절대적 경험치와 상대적 경험치가 있을 수 있기때문에

    레벨 시스템 리그를 나눈다. (온라인과 오프라인)

Project Browser

• (Option) 데스크탑 내 file folder List를 import.

  • import java.nio.file.* 라이브러리 이용. Java Folder Path Import (기본)

    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js" integrity="sha512-7Z9J3l1+EYfeaPKcGXu3MS/7T+w19WtKQY/n+xzmw4hZhJ9tyYmcUS+4QqAlzhicE5LAfMQSF3iFTK9bQdTxXg==" crossorigin="anonymous" referrerPolicy="no-referrer"></script>

  • mport java.nio.file.* 라이브러리 이용. Entity 에 저장

    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js" integrity="sha512-7Z9J3l1+EYfeaPKcGXu3MS/7T+w19WtKQY/n+xzmw4hZhJ9tyYmcUS+4QqAlzhicE5LAfMQSF3iFTK9bQdTxXg==" crossorigin="anonymous" referrerPolicy="no-referrer"></script>

  • 저장된 path 를기반으로 List 생성

    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js" integrity="sha512-7Z9J3l1+EYfeaPKcGXu3MS/7T+w19WtKQY/n+xzmw4hZhJ9tyYmcUS+4QqAlzhicE5LAfMQSF3iFTK9bQdTxXg==" crossorigin="anonymous" referrerPolicy="no-referrer"></script>

    public List<File> findAllFilesInDirectory(String directoryPath) {
        return entityManager.createQuery("SELECT f FROM File f WHERE f.fileLocation LIKE :path AND f.isDirectory = false", File.class)
            .setParameter("path", directoryPath + "%")
            .getResultList();
    }

• import 혹은 새로 생성한 BrowserList D.B에 저장

  • (Entity)

• 만들어진 목록에 대응하여 WikiPage 모두 생성.

파일 RW (Read, Write)

• Description Page 생성 (Write),

• 파일 이동,

• 파일명 변경,

• 파일 삭제,

• 파일 내부 데이터 각 각 변경 & 삭제, 추가(date,location, category,...)

• 현재 database 내 파일,폴더 경로 Listup & 조회(Read)

(Option) 파일 경로 최신으로 동기화

• Project Browser기반으로 OS 파일 경로 동기화 (Export)

• OS기반으로 Project Browser 파일 경로 동기화 (Import)

(Option) 대시보드 (FE)

• DB가 비어있으면 가운데 import 버튼으로 folder list(import java.nio.file.*) 가져오기

  • import java.nio.file.*

  • (Option) 가장 Update 날짜 맨위에 표기 (FE)

  • (Option) json,cvs파일 가져오기

• File,Folder description page 생성시 들어가는 D.B

  • 현재 위치 추가할지 여부 확인 후 위치 가져오기

  • date 가져오기

  • description markdown base.

  • (Option) file link 첨부 (App 연결해서 open하도록)

  • (Option) to do list

  • (Option) League

  • (Option) Priority choice

• 프로젝트 브라우저 (기본, 폴더 기반)

  • Sorted by name (default)

  • Sorted by date

  • Sorted by Category

  • Sorted by Location

  • 파일,폴더 클릭시 file description page 생성

  • 파일 이동

  • 파일명 변경

  • 파일 삭제

  • 데이터 정렬 집합에 따라 정렬된 브라우저 파일 목록을 볼 수 있습니다.

  • 프로젝트 설명 파일에는 데이터 정렬 집합이 포함되어 있습니다.

  • 파일 브라우저 목록은 기본적으로 데스크탑의 폴더 목록과 파일 목록으로 정렬됩니다.

  • 프로젝트 브라우저 (날짜, 카테고리,위치, 원하는 form 기반으로 정렬)

  • 프로젝트 파일 클릭시 마크다운 기반 글 description

    AI 요약 (ex; api doc처럼 자동으로 해당 프로젝트 기능을 데이터 기반으로 요약 생성)

    comment 덧붙이기

  • (Option) Sorted by To do date

  • (Option) Sorted by League

  • (Option) Sorted by Priority

• 지도 기반 대시보드

  • google map web dashboard page 에 가져오기 (BE)

  • google map 표기(FE)

  • 특정 위치에 점으로 DB연결 클릭시 창 열리도록

  • 위치기반 api 연동

    • 위치 기반은 Google MAP을 사용하며, 위치는 Google의 MAP API 테이블에 의해 기록됩니다.

• 캘린더 기반 대시보드

  • google calendar web dashboard page 에 가져오기 (BE)

  • google calendar 표기(FE)

  타겟 데이

  프로젝트 to do 할일 타겟 데이 데시보드에 표현.
  • 날짜 및 시간은 UTC 기준입니다. 사용자가 다른 시간대를 사용하는 경우, 애플리케이션은 사용자의 시간대로 전환합니다.
  

• (Option) to do 체크 기반 대시보드

  • 관리자가 요청하고 컨펌해야 체크완료

    • 관리자가 요청하는 문제에 대한 return값을 가져오는 객관식 or 주관식 demand거나

    • 자유 형식의 demand 보고서 파일

    • 관리자는 위와같이 형식을 자유자재로 정해서 요청할 수 있고, 해당 요청에 대해 member는 제출을 해야한다. member끼리 본인 것 제외 투표가 가능.

    • (옵션)제출된 결과값이 반영될 시 비교값을 보여줄 수 있도록 시각화 하는 기능도 차후 추가.

• (Option) League, Level, 경험치 기반 대시보드

  Level 순으로 계정 나열

  경험치 순으로 퀘스트 나열

  • 리그 대시보드는 사용자(관리자, 팀원)와 프로젝트의 리그, 레벨, 경험을 표시합니다.

  • 앞으로 온라인과 오프라인으로 구분될 예정입니다.

• (Option) 우선순위, 투표 기반 대시보드

  • 우선순위는

    1. 투표수가 가장 많은게 우선순위 높도록

    2. 높은 관리자가 만든 prj가 높도록 설정

  • 우선순위 대시보드에는 투표 시스템이 있습니다.

  • 프로젝트 관리자는 프로젝트의 우선순위를 수정할 수 있지만 기본 우선순위는 투표 순위와 권한 순위입니다.

• (차후) 알림, 모니터링

  날짜 기반 to do 알림 보내기

• (차후) 데이터베이스 AI

  데이터 기반 리스트들을 받아서 어떤 형태의 form이 좋은지 나중에 추천가능하도록

  데이터들을 모은다.

• (차후) 인기도, 관심도 카테고리 추가

2. 시나리오 (Ver 1.0) 📚

• 1. 회원가입 후 로그인 & 유저들 조회 & 유저들 삭제 기능

• 2. 로그인한 유저의 특정 개인 폴더와 같이 Project Browser List 생성

  • (Option)

• 3. Project Browser List 기반 모든 Folder,File에 대응하는 빈 Description Page 생성

  • (저장위치는 별개)

• (Option) (FE) 차후 구현

  • 4. (Option) (FE) 생성된 Folder, File Browser List를 시각화

  • 5. (Option) (FE) 시각화 된 File,Folder클릭 시 해당 경로 값을 기반으로 Description Page 보여주기

  • 7. (Option) (FE) Board 생성 버튼 클릭 가능하도록 만들기

  • 9.(Option) (FE) Board Table 시각화 (각 카테고리별로 다름)

• 6. 생성된 Description Page에 값을 넣어 저장.

• 8. (BE) Board 생성 버튼 ⇒ Description Page에 기입된 데이터를 기반으로 Board Table 생성

  1. 첫번째 Board Table은 Project Browser List (Default Board)

  2. (Option) 두번째 Board Table은 To do List

(Option)

9. 유저별 권한 다양화 (Ver 2.0)

10. To do List 구현 (Team Leader, Member가 요청)

11. 알람 구현 (To do 를 할 사람에게, 받는사람에게, 완료 후 확인 버튼까지)

12. 카테고리 다양화 (MAP, Calendar) (Ver 3.0)

13. OPEN API - chat gpt 활용하여 Browser List 추천 생성 등… 활용

• 프로젝트 종료 전 최종 Ver에서 SNS 계정 API를 통해 회원가입 & 로그인 구현

• Ver 1.0으로 구현해보기

99. ERD