Skip to content

Repository files navigation

DBP-Manager

実世界データの管理を行うリポジトリ

環境構築

Dockerを使用する構築方法と使用しないローカルの構築方法があリます。 まず、共通の手順について、その後別々の手順について説明します。

Dockerとローカル共通の手順

  1. 本リポジトリをクローン

    git clone https://github.com/exdata-inc/DBP-Manager.git

  2. 環境変数を2ファイルで設定

    1. .env.sampleをコピーして.envを作り、必要に応じて書き換え

      環境変数の詳細
      • MySQL
        • MYSQL_ROOT_PASSWORD: MySQLのroot用のパスワード
        • MYSQL_DATABASE: MySQLで利用するデータベース名
        • TZ: タイムゾーン
        • MYSQL_USER: DjangoサーバがMySQLサーバにアクセスする際のユーザ名
        • MYSQL_PASSWORD: DjangoサーバがMySQLサーバにアクセスする際のパスワード
      • Django
        • SECRET_KEY: Djangoのシークレットキー
        • DEBUG: デバッグモードにするかどうか
        • ALLOWED_HOSTS: Djangoサーバのホスト名(カンマ区切り)
        • CLIENT_ORIGIN_URLS: クライアントのURL(カンマ区切り)
        • DATABASE_ENGINE: 使用するDBエンジン
        • DATABASE_PORT: DBのポート番号
        • DATABASE_HOST: DBのホスト名
      • スーパーユーザ
        • RWDB_SU_USERNAME: スーパーユーザ名
        • RWDB_SU_PASSWORD: スーパーユーザのパスワード
        • RWDB_SU_EMAIL: スーパーユーザのメールアドレス
      • RWDB
        • RWDB_URL_PREFIX: サーバのURL
    2. client/.env.sampleをコピーしてclient/.envを作り、必要に応じて書き換え

      環境変数の詳細
      • VITE_RWDB_URL_PREFIX: サーバのURL
      • VITE_API_ROOT_PATH: APIのルートパス(変更しないでください)
      • VITE_MAPBOX_TOKEN: Mapboxのトークン
      • VITE_MDA_URL: 構造情報を生成するサーバのURL

Dockerを使用する場合の手順

  1. Dockerコンテナの立ち上げ

    リポジトリのルートで、docker compose up -d --buildを行う。

  2. ブラウザで、http://localhost:3002にアクセス

ローカルでの手順

  1. Python3.12の環境を用意し、パッケージをインストールする

    pip install -r requirements.txt
  2. MySQLのデータベースを作成

    mysql.server startでMySQLを起動させ、mysql -u rootでログインします。
    create database {database_name};と入力して、MySQL上にデータベースを作成します。 exitコマンドでログアウトします。

    {database_name}には、環境変数で設定したMYSQL_DATABASEと同じものを入力してください。

  3. データベース情報の反映

    以下を入力します。

    python server/manage.py makemigrations
    python server/manage.py migrate
    python server/manage.py createcustomsuperuser --username {user_name} --password {password} --noinput --email {email}
    python server/manage.py createPredicate5W1H
  4. Djangoサーバの立ち上げ

    python server/manage.py runserver 0.0.0.0:{server_port}

    {server_port}には、環境変数の設定に応じて適切なポート番号にします。

  5. client/README.mdに従って、クライアントの環境構築

  6. クライアントサーバの立ち上げ

    bun run dev --port {client_port}

    {client_port}には、環境変数の設定に応じて適切なポート番号にします。

  7. ブラウザで、http://localhost:{client_port}にアクセス

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages