fit track

フィットトラック

Fit-Trackは、Mern（Mongodb、Express、React+Vite、node.js）スタックを使用して構築されたエクササイズログトラッキングアプリケーションです。このドキュメントでは、このプロジェクトに貢献するプロセスを案内します。

目次

• インストール
  • フロントエンド
  • バックエンド
• 貢献
  • リポジトリを分岐します
  • リポジトリのクローニング
  • ブランチの作成
  • 変更を加えます
  • 変更を犯します
  • 変更をプッシュします
  • プルリクエストを作成します
• ライセンス

インストール

フロントエンド

1. frontendディレクトリに移動します。

    cd frontend

2. 依存関係をインストールします。

   npm install

3. 開発サーバーを開始します。

   npm run dev

バックエンド

1. backendディレクトリに移動します。

    cd backend

2. 依存関係をインストールします。

   npm install

3. Mongodb Atlasのセットアップ：

   1. Mongodb Atlasにアクセスして、アカウントをまだ持っていない場合はアカウントを作成します。
   2. プロンプトに従って新しいクラスターを作成します。 Mongo Atlas Cluster Creationチュートリアル
   3. クラスターが作成されたら、データベースアクセスセクションに移動し、必要な特権を持つユーザーを作成します。
   4. ネットワークアクセスに移動して、IPアドレスを許可します（または、ローカルでテストする場合はどこからでもアクセスを許可します）。
   5. クラスターセクションで、 [接続]をクリックし、 [アプリケーションの接続]を選択します。次のような接続文字列が表示されます。

       mongodb+srv://<username>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
      

   6. <username>および<password>を実際のmongodb atlasユーザー名とパスワードに置き換えます。接続文字列全体をコピーします。

4. mongodb atlas_uriを.envファイルに追加します：

   • backendディレクトリに.envファイルを作成します。
   • 次の行を.envファイルに追加し、 <your-mongodb-connection-string> Mongodb Atlasからコピーした接続文字列に置き換えます。

     ATLAS_URI=mongodb+srv:// < username > : < password > @cluster0.mongodb.net/fit-track ? retryWrites=true & w=majority

5. サーバーを開始します：

   node server.js

   または、バックエンドのライブアップデートのためにnodemonがインストールされている場合：

   nodemon server.js

プロジェクト構造

フロントエンド

frontendディレクトリにはReactアプリケーションが含まれています。

• public ：アプリケーションの公的資産が含まれています。
• src ：アプリケーションのソースコードが含まれています。
  • components ：再利用可能なUIコンポーネント。
    • Home ：ホームページコンポーネント
      • Exercise ：列のコンポーネントを行使して、ステータス、デイチェックを表示する
      • ExercisesList ：ユーザーが行ったエクササイズのリストを表示するには
      • HeatMap ：apexcharts.jsを搭載してユーザーエクササイズルーチンを表示する
      • Quotes ：APIニンジャスから、ユーザーの動機付けのために引用符をランダムに表示します
      • TotalDays ：ユーザーが行使した日数を表示するには
      • UserExperience ：ゲーミー化されたエクスペリエンスでユーザーエクスペリエンスを表示する
      • UserRoutine ：連勝のようにユーザーの毎週のルーチンを表示する
    • HomePage ：ホームページの表示とレンダリング
    • Login ：ログインページの表示
    • SignUp ：サインアップと編集ユーザーページを表示します
    • navbar ：Navbarコンポーネント
• App.jsx ：ルートをセットアップするメインコンポーネント。
• main.jsx ：Reactアプリケーションのエントリポイント。

バックエンド

backendディレクトリには、node.jsサーバーとExpressアプリケーションが含まれています。

• models ：マングーススキーマが含まれています。
  • exercise.model ：運動スキーマ
  • user.model ：ユーザースキーマ
• routes ：APIルートが含まれています。
  • exercises ：エクササイズ用のバックエンドAPIルート
  • user ：ユーザー向けのバックエンドAPIルート
• server.js ：サーバーアプリケーションのエントリポイント。

貢献

貢献を歓迎します！フィットトラックに貢献するには、次の手順に従ってください。

リポジトリを分岐します

1. GitHubのリポジトリページの右上にある「フォーク」ボタンをクリックして、リポジトリをフォークします。

リポジトリのクローニング

2. フォークリポジトリをローカルマシンにクローンします。

   git clone https://github.com/your-username/Fit-Track.git

3. プロジェクトディレクトリに移動します。

    cd Fit-Track

ブランチの作成

4. 機能またはバグ修正のための新しいブランチを作成します（取り組んでいる問題に従ってブランチを作成します）：

   git switch -c your-branch-name

変更を加えます

5. コードベースに変更を加えます。推奨コードエディターを使用してファイルを編集できます。

変更を犯します

6. ステージング領域に変更を追加します。

   git add .

7. 説明的なメッセージで変更をコミットします。

   git commit -m " Description of your changes "

変更をプッシュします

8. フォークされたリポジトリへの変更をプッシュします。

   git push origin your-branch-name

プルリクエストを作成します

9. フォークリポジトリからメインリポジトリまでのプルリクエストを作成します。メインリポジトリの[[プル]リクエスト]タブに移動し、[新しいプルリクエスト]をクリックします。手順に従って、プルリクエストを作成します。

これはほんの始まりです！より有意義な貢献をし、この驚くべきコミュニティと協力することを楽しみにしています。一緒に何か素晴らしいものを構築し、それができる限り最善を尽くしましょう！ ❤§？

ライセンス

このプロジェクトは、MITライセンスに基づいてライセンスされています。詳細については、ライセンスファイルを参照してください。