Skip to content

SIAT A반 멤버들을 소개하는 나무위키 프로젝트입니다. (프론트엔드)

Notifications You must be signed in to change notification settings

SIAT-Python-Project/SIATwiki-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

씨앗위키 - Frontend 💚

나무위키만 있냐 씨앗위키도 있다

목차

  1. 웹 서비스 소개
  2. 프로젝트 구성
  3. 구현 기능
  4. 와이어프레임
  5. 역할

Getting Started

  1. Clone the repo
   git clone https://github.com/SIAT-Python-Project/SIATwiki-frontend.git
  1. Build Project
npm i
npm run start

1. 웹 서비스 소개

  • 씨앗 A반 사람들의 인물 위키 서비스

  • 기획 의도 : 파이널 프로젝트를 약 2주 남긴 상황에서, 우리는 아직까지 모든 구성원들이 프로젝트를 함에 있어서 무엇을 지향하는지, 자세히 알지 못하고 있습니다.

    ...

    그래서 나온 '나무위키'에 착안한 씨앗위키 서비스!!!

    이제 본인 소개부터 다른 사람들의 소개까지, 자유롭게 읽고 수정해봐요!



  • 주요 기능 :

    • 회원가입, 로그인 서비스
    • 인물 문서 생성 서비스 (프로필 사진도 있어요!)
    • 인물 정보 수정 서비스
    • 쿠키와 인터셉트를 이용한 커스텀 예외 처리
    • 검색창 자동완성 기능
    • 나무위키에 착안한 CSS

2. 프로젝트 구성

기술 스택 및 라이브러리

분류 Tools 목적
Frontend React Web Framework
Frontend style-components CSS
Frontend MUI CSS
Frontend axios proxy, API 통신
Backend Spring Web Framework
Backend MySQL Database
Backend Git bot CI를 통한 자동 Merge

3. 구현 기능

  • Authentication : 회원가입 / 로그인 / 로그아웃 / 쿠키 조작 검증 / 유저 생성, 수정 권한 필터링
  • 유저 생성 : 유저의 기본 인적사항을 입력하여, 위키 문서 생성
  • 유저 정보 수정 : 위키 문서 내 개요,수정,프로젝트 지향점, 본인의 일하는 스타일 등등..수정 가능
  • 컴포넌트화 : Components의 템플릿화를 통한 Page 간결화

4. Coming Soon

  • Overview와 Info Anchor 기능
  • 창에 입력값이 있는 상태에서 엔터 시 검색으로 넘어가도록 UX 개선

(back to top)

5. API 명세서

Category API 명세서

Domain 메소드 방식 요청 경로 요청값 반환값
Category GET /api/info/category CategoryResponseDto

Info API 명세서

Domain 메소드 방식 요청 경로 요청값 반환값
Info POST /api/info InfoDto.InfoRequestDto InfoDto.InfoResponseDto
Info GET /api/info/{infoId} InfoDto.InfoResponseDto
Info GET /api/info/person/{personId} List<InfoDto.InfoResponseDto>
Info PUT /api/info/{infoId} InfoDto.InfoRequestDto InfoDto.InfoResponseDto

Person API 명세서

Domain 메소드 방식 요청 경로 요청값 반환값
Person GET /api/person/{personId} PersonDTO.PersonResponseDTO
Person POST /api/person PersonDTO.PersonRequestDTO, MultipartFile PersonDTO.PersonResponseDTO
Person PUT /api/person/{personId} PersonDTO.PersonRequestDTO, MultipartFile PersonDTO.PersonResponseDTO
Person DELETE /api/person/{personId} void
Person GET /api/person List<PersonDTO.PersonIdNameDTO>

User API 명세서

Domain 메소드 방식 요청 경로 요청값 반환값
User POST /api/sign-up UserDTO.UserRequestDTO User
User POST /api/login UserDTO.UserRequestDTO Boolean
User POST /api/logout Boolean
User POST /api/userFind UserDTO.UserRequestDTO List<UserDTO.UserResponseDTO>

6. 역할

이름 담당 업무
김지혜 바지사장, Frontend, 아이디어 기획, Person CRUD
배창민 Backend (User CRUD, Cookie 관리)
장희권 진짜사장, DBA, Backend ( Authentication, Global Exception Handling, Info CRUD, File server),CI

About

SIAT A반 멤버들을 소개하는 나무위키 프로젝트입니다. (프론트엔드)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •