yeji222 / springboot_rss_local

Readme Studio

🗓️ 프로젝트 기간

2023.03.07 ~ Now

📔목차

• 프로젝트 설명
  • 주제
  • 기획 배경
  • 기술 스택
• Getting Started
  • 설치
• 사용 방법
• Contributors
• Trouble Shooting

🌟 프로젝트 설명

주제

• 깃허브 레포지토리 링크나 프로젝트 파일을 올리면 해당 내용으로 README를 자동생성 해주고, 부가적으로 사용자가 원하는 옵션으로 반영이 되도록 해주는 Readme.md 파일 자동생성 웹 서비스

기획 배경

• 프로젝트를 진행하며 Github에 업로드 이후 README를 작성해야 하는데 생각보다 많은 시간이 들어가고 번거로운 부분이 많다. 특히 프로젝트에 대한 내용을 작성할 때 하나하나 프로젝트 내에서 찾아 적는 것이 귀찮았다.

서비스 대상

• Github README 파일로 포트폴리오를 만들고 싶어하는 대학생
• 프로젝트에 대해 적극적으로 홍보하고 싶어하는 사람들

서비스 목적

• 직접 README 파일의 모든 내용을 작성 할 필요 없이 프로젝트의 소스코드를 파싱해서 README의 내용들을 작성할 수 있는 인터페이스를 제공한다.
• Spring Boot의 구조를 파악하고 해당 구조에 따른 Database의 구조와 사용 방식등을 포함하도록 한다.
• README 파일에서 가시성을 높여주는 여러 시각적 요소(배지, 그래프, 테이블 등)등을 링크를 입력할 필요 없이 자동으로 만들어 줌으로써 README파일을 작성 할 때 귀찮음을 덜어준다.

Database ERD

framework

name	content
name	제공되는 interface framework의 이름
content	해당 framework에서 사용되는 내용 (태그 정보)
type	각 framework를 나누기 위한 ID값

project

name	content
ID	프로젝트에 부여된 고유 random id
file_name	파일 이름
file_path	파일이 프로젝트 내에서 저장된 위치
file_content	파일의 내용
detail	해당 파일의 종류

user

name	content
project_id	프로젝트에 부여된 고유 random id
repository_name	프로젝트 Github Repository 이름
user_name	프로젝트 관리자 Github name

🚀 기술 스택

• Spring Boot
• React.js
• MariaDB
• IntelliJ

🧰 Getting Started

⚠️ 호환

• SpringBoot Controller 코드 내에서, Mac OS와 Window의 ProcessBuilder 코드가 다릅니다.
• OS 환경에 맞게 코드를 변경 후, 사용해주세요. (mac, window로 주석처리 되어 있습니다)

// EX 

builder.command("mkdir", "unzipFiles"); // mac
builder.command("cmd.exe","/c","mkdir", "unzipFiles"); // window

⚙️ 설치

• 해당 프로젝트를 Local 환경에 clone 받아야 합니다.

git clone https://github.com/DevDachan/Readme_generate

• React에서 해당 프로젝트에 필요한 package를 설치해야 합니다.

$ npm install

👀 Usage

1. spring boot project의 Github Repository URL을 입력한다.

2. 이후 화면 우측에 제공되는 interface를 통해서 README에 대한 내용을 작성하도록 한다.

3. 최종적으로 작성된 README 파일을 다운로드한다.

⚠️ Troubleshooting

👋 Contributors

🧑🏻‍💻 MinSoo Kim

🧑🏻‍💻 DaChan Seo

👩🏻‍💻 YeJi Hong