readme generator

README 생성기 프로젝트

프로젝트 개요

README 생성기 프로젝트에 오신 것을 환영합니다! 이 혁신적인 도구는 소프트웨어 프로젝트용 README 파일 생성 프로세스를 간소화하도록 설계되었습니다. 생성적 AI의 강력한 기능을 활용하여 사용자는 목적, 기능, 기술적 세부 사항을 포함하여 프로젝트에 대한 간략한 설명을 입력할 수 있으며 모범 사례에 따라 잘 구조화되고 유익한 README.md 파일을 생성할 수 있습니다.

? 특징

• 사용자 친화적인 인터페이스 : 웹 인터페이스는 프로젝트 세부 정보를 입력하고 README 파일을 쉽게 생성할 수 있는 직관적인 방법을 제공합니다.
• 동적 파일 입력 : 사용자는 사용자 정의 이름과 코드 조각을 사용하여 여러 파일을 추가할 수 있으므로 프로젝트 구성 요소에 대한 포괄적인 문서화가 가능합니다.
• 동적 README 생성 : 사용자 입력을 기반으로 README 파일을 자동으로 생성합니다.
• Generative AI 통합 : Generative AI 모델을 활용하여 사용자 입력을 기반으로 README 파일을 생성하여 정확성과 관련성을 보장합니다.
• 사용자 정의 가능한 구성 : 사용자는 온도, top p, top k 및 안전 설정과 같은 생성 설정을 구성하여 원하는 대로 출력을 맞춤화할 수 있습니다.
• AI 기반 콘텐츠 : 생성 AI를 활용하여 흥미롭고 유익한 콘텐츠를 만듭니다.
• 사용자 정의 가능 : 사용자가 프로젝트 요구 사항에 따라 README 파일을 사용자 정의할 수 있습니다.
• 이모티콘 지원 : 더욱 매력적인 사용자 경험을 위해 이모티콘으로 README를 강화합니다.

기술적인 세부사항

README Generator 프로젝트는 백엔드용 Flask와 프런트엔드용 Express.js의 조합으로 구축되었습니다. Google Generative AI 모델을 사용하여 README 콘텐츠를 생성하여 고품질의 관련 출력을 보장합니다.

백엔드( app.py )

백엔드는 README 콘텐츠 생성을 처리합니다. 사용자 입력을 받아 처리하고 생성 AI 모델과 통신하여 README를 생성합니다.

프런트엔드( public/app.js )

프런트엔드는 사용자가 프로젝트 세부 정보를 입력하고 README를 생성할 수 있는 대화형 사용자 인터페이스를 제공합니다. 백엔드와 통신하여 사용자 입력을 보내고 생성된 README를 받습니다.

시작하기

README GPT를 실행하려면? 로컬에서는 다음 단계를 따르세요.

1. 저장소 복제: git clone https://github.com/chiragjoshi12/readme-generator.git
2. 프로젝트 디렉터리로 이동합니다: cd readme-generator
3. 종속성을 설치합니다.
   • Flask 백엔드의 경우:

      cd backend
     pip install -r requirements.txt
     

   • Node.js 프런트엔드의 경우:

      cd public
     npm install
     

4. 환경 변수를 설정합니다.
   • backend 디렉터리에 .env 파일을 만들고 Generative AI API 키를 추가합니다.

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. Flask 서버 시작: python app.py
6. 프런트엔드용 Node.js 서버를 시작합니다.

용법

1. 웹 브라우저를 열고 http://localhost:3000 으로 이동합니다.
2. "파일 추가"를 클릭하여 프로젝트 세부 정보를 입력하세요.
3. 파일 이름과 코드 섹션을 입력합니다.
4. README 파일을 생성하려면 "README 생성"을 클릭하세요.

? 기여

이 프로젝트에 자유롭게 기여하고 개선해 보세요!

? 연락하다

질문이나 제안 사항이 있는 경우 언제든지 [email protected]으로 Chirag Joshi에게 연락하세요.

---

Chirag Joshi의 ❤️로 제작됨

README GPT를 사용해 주셔서 감사합니다!