hackathon project at sgu

SGUハッカソンプロジェクト

問題ステートメント - リモート チーム向けの共同プロジェクト管理ツール

使用されている技術

このプロジェクトはMERNスタックを使用して構築されています。

• MongoDB : アプリケーション データを保存するための NoSQL データベース。
• Express.js : Node.js の Web アプリケーション フレームワーク。
• React : ユーザー インターフェイスを構築するための JavaScript ライブラリ。
• Node.js : Web ブラウザーの外部で JavaScript コードを実行する JavaScript ランタイム環境。

前提条件

プロジェクトをセットアップする前に、次のソフトウェアがマシンにインストールされていることを確認してください。

• Node.js (バージョン 14 以降を推奨)
• npm (Node.js に付属) またはYarn

はじめる

以下の手順に従って、プロジェクトをセットアップして実行します。

1. リポジトリのクローンを作成する

リポジトリのクローンをまだ作成していない場合は、次のコマンドを使用してクローンを作成できます。

git clone https://github.com/altamsh04/hackathon-project-at-sgu.git
cd hackathon-project-at-sgu

2. 依存関係をインストールする

プロジェクト ディレクトリに移動し、npm または Yarn を使用して必要な依存関係をインストールします。

 # Using npm
npm install

このコマンドは、 package.jsonファイルにリストされている必要なパッケージをすべてインストールします。

3. 開発サーバーを実行する

開発サーバーを起動するには、次のコマンドを使用します。

 # Using npm
npm run dev

プロジェクトの構造

 hackathon-project-at-sgu/
├── public/                # Static assets like images and icons
├── server/                # Server backend
├── src/
│   ├── assets/            # Local image files, fonts, etc.
│   ├── components/        # Reusable React components
│   ├── pages/             # Page-level components or views
│   ├── App.jsx            # Main application component
│   ├── main.jsx           # Entry point for the React app
│   └── index.css          # Global styles
├── index.html             # Main HTML template
├── package.json           # Project dependencies and scripts
├── vite.config.js         # Vite configuration file
└── README.md              # Project documentation

キーファイル

• src/main.jsx : これは React アプリケーションのエントリ ポイントです。
• src/App.jsx : アプリケーションのメイン レイアウトを含むルート コンポーネント。
• vite.config.js : Vite の構成ファイル。ビルドおよび開発設定をカスタマイズできます。
• index.html : React アプリケーションを提供するために Vite によって使用される HTML テンプレート。

協力者?

• @altamsh04
• @pradip5474
• @Shreyas-Patil-11
• @junnu01