ReadMeAI

? readmeai?

개요

ReadMe Generator는 사용자가 단일 파일 코드를 업로드하고 프로젝트를 설명 할 수있는 플랫폼입니다. AI는 코드 편집기를 사용하여 실시간으로 편집 할 수있는 Markdown 코드를 생성하며 변경 사항을 즉시 미리 볼 수 있습니다.

Readmeai는 이제 Readmeai.live에서 살고 있습니다

항해

• ? readmeai?
  • 개요
  • 항해
  • ? 특징
  • 파일 구조 (MVC)
  • 기술 스택
  • 설치
    • 로컬 기계에서
    • 가상 머신에서 (Docker 사용)
  • 용법
    • 로컬 기계에서
    • Docker 컨테이너 사용
  • ? 다음 릴리스 기능.
  • ?지원하다
  • ✍️이 작가

? 특징

• AI 기반 컨텐츠 : Google AI를 사용하여 프로젝트 설명, 사용법, 설치 등을 포함하여 README에 대한 의미 있고 유익한 컨텐츠를 생성합니다.

• 사용자 정의 : 내장 된 편집기를 사용하여 생성 된 컨텐츠를 특정 섹션을 포함 시키거나 제외하여 README에 프로젝트의 고유 한 요구를 반영 할 수 있습니다.

• Markdown 지원 : 생성 된 readme 파일은 Markdown을 사용하여 프로젝트 문서를 쉽게 형식화하고 스타일링 할 수 있습니다.

• 사용자 친화적 인 웹 인터페이스 : 사용자 친화적 인 웹 인터페이스를 통해 생성기에 액세스하여 수동 설정이 필요하지 않습니다.

파일 구조 (MVC)

• ? API/ : 타사 API에 연결할 코드 파일이 포함되어 있습니다 (Google Palm 2)
• ? Controllers/ : Post/ Get 요청에서 실행할 모든 비즈니스 논리가 포함되어 있습니다.
• ? Views/ : 클라이언트 측에서 렌더링 할 파일이 포함되어 있습니다.
• ? Data/ : 출력 템플릿과 마크 다운을 출력하는 'output.md'를 보유하는 '템플릿' 이 포함되어 있습니다.
• ? public/ : 클라이언트 측 CSS 및 스크립트를 포함합니다.
• ? 경로/ : 경로를 처리하고 특정 경로에서 각 컨트롤러 기능을 호출 할 파일.
• ? 업로드/ :이 디렉토리는 클라이언트 측에서 서버가 수신 한 파일을 보유한 다음 세션이 끝나면 삭제됩니다.
• ? Server.js :이 파일은 기본 Express 서버 입니다. 이것은 시작 서버에서 실행되는 파일입니다.
• ? dockerfile :이 파일에는 컨테이너화 프로젝트 스크립트가 포함되어 있습니다.

기술 스택

• node.js : 서버 측 런타임.
• Express : Node.js 프레임 워크.
• ? Google Palm API : Google Pathways Language Model은 5 억 4 천만 파라미터 변압기 기반 대형 언어 모델입니다.
• ? EJS : 서버에서 HTML에서 동적 컨텐츠를 렌더링하고 추가하기위한 엔진 템플릿.
• ? CSS : HTML 템플릿 스타일링.
• JavaScript : 프론트 엔드에 상호 작용을 추가합니다.

설치

로컬 기계에서

1. 저장소를 복제하십시오.
2. 프로젝트 디렉토리로 이동하십시오.
3. 터미널을 열고 실행하십시오.

    npm install

가상 머신에서 (Docker 사용)

1. 레포를 복제하고 프로젝트 디렉토리로 이동하십시오.
2. 터미널을 열고 다음 명령을 입력하십시오.

     docker build -t gitax18/readmeai . 

용법

로컬 기계에서

1. 프로젝트 디렉토리로 변경하십시오.
2. 터미널을 열고 다음 명령을 입력하십시오.

    npm start

3. 응용 프로그램은 http : // localhost : 3333에서 실행됩니다

Docker 컨테이너 사용

1. 컨테이너를 시작하려면 다음 명령을 입력하십시오.

    docker run -it -p 3333:3333 gitax18/readmeai

2. 이제 응용 프로그램은 http : // localhost : 3333에서 실행됩니다

---

참고 : 프로젝트가 제대로 실행되지 않고 웹 콘솔에 CRBUG 오류를 표시하면 다음 단계를 따르십시오.

1. vscode el 왼쪽 사이드 바에서 '실행 및 디버그'메뉴로 이동합니다.
2. 'launch.json 파일 만들기'를 클릭하고 팝업 메뉴에서 node.js를 선택하십시오.
3. 이제 동일한 '실행 및 디버그'사이드 바의 상단에서 녹색 삼각형 재생 아이콘을 클릭하십시오.
4. 이제 http : // localhost : 3333으로 이동하십시오

? 다음 릴리스 기능.

• 단일 파일 대신 repo를 추가 할 github 권한.
• 더 많은 훈련 된 AI가 파일이 아닌 폴더에 대한 readme를 생성합니다.
• 사용자 정의 템플릿, 사용자는 README에서 원하는 기능/섹션을 정의 할 수 있습니다.

?지원하다

문제가 발생하거나 질문이 있으시면 저장소에 대한 문제를 자유롭게 작성하십시오. 우리는 도와 드리기 위해 왔습니다!

✍️이 작가

• Gitanshu Sankhla (백엔드 개발자) -

• Vijay Banjara (Frontend Developer) -
  

• 가혹한 쿠마르 (디자이너) -