makeread.me
1.0.0
프로젝트를 시작하는 멋진 README 생성기!
문서 탐색»
데모보기. 보고 버그. 요청 기능
오픈 소스 소프트웨어를 구축하고 기여하는 데 따른 과제 중 하나는 많은 프로젝트가 놀라운 기능을 가지고 있지만 명확하고 사용자 친화적 인 설치 지침이 부족하여 더 많은 청중에게 다가가는 것을 놓치는 경우가 종종 있다는 것입니다. 또한 사용 사례의 효율적인 쇼케이스가 부족하면 이러한 프로젝트의 낮은 범위에 기여합니다.
이 문제를 해결하는 데 도움이되는 README 템플릿이 있지만 이러한 템플릿을 수동으로 작성하는 프로세스는 시간이 많이 걸리고 지루할 수 있습니다. 그것이 우리 프로젝트 Makeread.me가 들어오는 곳입니다.
프로젝트 문서를 만드는 방법에 혁명을 일으킬 수있는 자동 readme 생성기 인 Makeread.me를 소개합니다. 설계되었습니다.
무료, 오픈 소스이며 고도로 사용자 정의 할 수 있습니다. 귀하의 요구에 맞게 템플릿을 자유롭게 수정하십시오. 특정 구성 요소가 누락 된 경우 프로젝트에 기여하고 확장하는 것을 환영합니다.
프로그래밍 방식 매핑을 위해 Nunjucks 및 JSON 템플릿을 사용하여 프로젝트에 쉽게 기여할 수있었습니다. Makeread.me와의 명확하고 간결한 프로젝트 문서의 이점을 누리십시오!
이 프로젝트는 다음과 같은 기술로 구축되었습니다.
이것은 프로젝트를 로컬로 설정하는 방법을 제공 할 수있는 방법의 예입니다. 로컬 사본을 올리십시오.
이 프로젝트는 원사를 시스템에 설치해야합니다. 설치하지 않은 경우 다음 단계를 수행 할 수 있습니다.
NPM (노드 패키지 관리자)을 사용하여 전 세계적으로 원사를 설치하십시오. 터미널을 열고 실행하십시오.
npm install -g yarn실을 실행하기 전에 Node.js 및 NPM이 설치되어 있는지 확인하십시오.
터미널에서 다음 명령을 실행하여 원사가 컴퓨터에 설치되었는지 확인하십시오.
yarn --version원사가 올바르게 설치된 경우 터미널에 시스템에 설치된 원사 버전이 표시되어야합니다.
이제 프로젝트 종속성을 관리하고 버전으로 사용하기 위해 원사를 사용할 준비가되었습니다!
성공적인 설치를 위해 다음 단계를 따르십시오.
저장소를 복제하십시오 : 저장소를 로컬 컴퓨터로 복제하여 시작하십시오.
https://github.com/ShaanCoding/makeread.me
프론트 엔드 패키지 설치 : "/frontend"디렉토리로 이동하고 터미널에서 다음 명령을 실행하여 필요한 원사 패키지를 설치하십시오.
yarn install백엔드 패키지 설치 : 마찬가지로 "/백엔드"디렉토리로 이동하고 터미널에서 다음 명령을 실행하여 필요한 원사 패키지를 설치하십시오.
yarn install환경 설정 :
"/backend"디렉토리에서 ".env.example"파일의 내용을 복사하고 ".env"라는 새 파일을 만듭니다. 요구 사항에 따라 환경 변수를 조정하거나 그대로 그대로 두십시오.
"Frontend/API/Generated/ReadMegenerator.ts"로 이동하여 기본 매개 변수를 백엔드 API 경로로 설정하십시오. 예를 들어, 포트 8080의 로컬 서버에서 백엔드를 실행하는 경우 다음을 설정해야합니다.
BASE: "http://localhost:8080/api" ;백엔드 실행 : "/백엔드"디렉토리로 이동하고 터미널에 다음 명령을 입력하여 백엔드 서버를 실행하십시오.
yarn dev프론트 엔드 실행 : 마지막으로 "/frontend"디렉토리로 이동하고 터미널에 다음 명령을 입력하여 프론트 엔드 서버를 실행하십시오.
yarn dev이제 응용 프로그램이 성공적으로 실행되어야합니다!
로드맵에는 완성 된 목표와 미래의 목표가 모두 포함됩니다. 우리가 성취하고 기대 한 내용은 다음과 같습니다.
우리는 Makeread.me의 기능을 향상시키고 확장하여 사용자에게 효율적이고 원활한 재입학 경험을 제공하기위한 노력을 계속합니다.
제안 된 기능 (및 알려진 문제)의 전체 목록은 열린 문제를 참조하십시오.
공헌은 오픈 소스 커뮤니티를 배우고, 영감을주고, 창조 할 수있는 놀라운 장소입니다. 당신이하는 모든 기여는 대단히 감사합니다 .
이를 더 좋게 만드는 제안이 있다면, repo를 포크하고 풀 요청을 만듭니다. "Enhancement"태그에 문제를 열면 간단히 문제를 열 수도 있습니다. 프로젝트에 별을주는 것을 잊지 마십시오! 다시 한 번 감사드립니다!
git checkout -b feature/AmazingFeature )git commit -m 'Add some AmazingFeature' )git push origin feature/AmazingFeatureMozilla Public License 2.0 라이센스에 따라 배포되었습니다. 자세한 내용은 Mozilla Public License 2.0 라이센스를 참조하십시오.
질문이나 제안이 있으시면 언제든지 저희에게 연락하십시오.
그들의 기여, 지원 및 영감에 대한 다음 덕분에 특별한 감사를드립니다.
이 readme은 makeread.me를 사용하여 생성되었습니다
