makeread.me
1.0.0
あなたのプロジェクトをジャンプスタートするための素晴らしいreadmeジェネレーター！
ドキュメントを探索»
デモを表示します。バグを報告します。リクエスト機能
オープンソースソフトウェアの構築と貢献に関する課題の1つは、多くのプロジェクトが驚くべき機能を持っているが、明確でユーザーフレンドリーなインストール手順がないため、より多くの視聴者にリーチすることを逃すことが多いことです。さらに、ユースケースの効率的なショーケースの欠如も、これらのプロジェクトの低い範囲に貢献しています。
これに対処するのに役立つreadmeテンプレートがありますが、これらのテンプレートを手動で記入するプロセスは時間がかかり、退屈な場合があります。それが私たちのProject Makeread.meが入ってくるところです。
Makeread.meを紹介します。Makeread.meは、プロジェクトドキュメントの作成方法に革命をもたらすことができる自動化されたREADMEジェネレーターです。それは次のように設計されています：
無料でオープンソースで、非常にカスタマイズ可能です。お客様のニーズに合わせてテンプレートを自由に変更してください。特定のコンポーネントが欠落していることがわかった場合は、プロジェクトに貢献して拡大することを大歓迎します。
プログラマティックマッピングのためにNunjucksとJSONテンプレートを使用して、プロジェクトに簡単に貢献できるようになりました。 Makeread.meで明確で簡潔なプロジェクトのドキュメントの利点をお楽しみください！
このプロジェクトは、次のテクノロジーで構築されました。
これは、プロジェクトをローカルに設定するための指示を与える方法の例です。ローカルコピーを稼働させるには、これらの簡単な例の手順に従ってください。
このプロジェクトでは、Yarnをシステムにインストールする必要があります。インストールしていない場合は、次の手順に従うことができます。
NPM（ノードパッケージマネージャー）を使用して、グローバルにYARNをインストールします。ターミナルを開いて実行します。
npm install -g yarn糸を実行する前に、node.jsとnpmがインストールされていることを確認してください。
ターミナルで次のコマンドを実行することにより、糸がマシンにインストールされていることを確認してください。
yarn --version糸が正しく取り付けられている場合、端末はマシンに取り付けられた糸のバージョンを表示する必要があります。
これで、プロジェクトの依存関係を管理およびバージョンするために糸を使用する準備ができました！
インストールを成功させるには、次の手順に従ってください。
リポジトリのクローン：リポジトリをローカルマシンにクローニングすることから始めます。
https://github.com/ShaanCoding/makeread.me
フロントエンドパッケージをインストール： 「/frontend」ディレクトリに移動し、端末で次のコマンドを実行して、必要な糸パッケージをインストールします。
yarn installバックエンドパッケージをインストール：同様に、端末で次のコマンドを実行して、「/backend」ディレクトリに移動し、必要な糸パッケージをインストールします。
yarn install環境のセットアップ：
「/backend」ディレクトリで、「.env.example」のコンテンツをコピーして、「.env」という名前の新しいファイルを作成します。要件に応じて環境変数を調整するか、そのままにしておくことができます。
「Frontend/API/generated/readmegenerator.ts」に移動し、ベースパラメーターをバックエンドAPIルートに設定します。たとえば、ポート8080のローカルサーバーでバックエンドを実行している場合は、次のことを設定する必要があります。
BASE: "http://localhost:8080/api" ;バックエンドの実行： 「/backend」ディレクトリに移動し、端末に次のコマンドを入力して、バックエンドサーバーを実行します。
yarn devフロントエンドの実行：最後に、「/frontend」ディレクトリに移動し、端末に次のコマンドを入力して、フロントエンドサーバーを実行します。
yarn devこれで、アプリケーションが正常に稼働しているはずです！
ロードマップには、完了した目標と将来の目標の両方が含まれます。これが私たちが達成し、楽しみにしていることです：
Makeread.meの機能を改善および拡大するというコミットメントを継続して、ユーザーに効率的でシームレスなReadme生成エクスペリエンスを提供します。
提案された機能（および既知の問題）の完全なリストについては、オープンな問題を参照してください。
貢献は、オープンソースコミュニティを学び、インスピレーションを与え、創造するのに驚くべき場所にするものです。あなたがする貢献はどんな貢献も大歓迎です。
これを改善する提案がある場合は、レポをフォークしてプルリクエストを作成してください。また、タグ「拡張機能」で問題を開くこともできます。プロジェクトにスターを与えることを忘れないでください！再度、感謝します！
git checkout -b feature/AmazingFeature ）git commit -m 'Add some AmazingFeature' ）git push origin feature/AmazingFeature ）Mozilla Public License 2.0ライセンスの下で配布。詳細については、Mozilla Public License 2.0ライセンスを参照してください。
ご質問や提案がある場合は、お気軽にご連絡ください。
貢献、サポート、インスピレーションに感謝します。
このREADMEは、makeread.meを使用して生成されました
