logvista-server

README

logvista-server

Logvista server for On-Premise

フロントエンドのビルド

1. yarn buildする際は、clientディレクトリ内の.envファイルのVITE_API_URLの値を以下のように設定すること
   • {{.VITE_API_URL}}は、サーバー起動時に、サーバー側の環境変数VITE_API_URLの値に置換される

   VITE_API_URL={{.VITE_API_URL}}
   

2. clientディレクトリ内でyarn buildを実行した結果のdistディレクトリ内のファイルを、staticディレクトリにコピーする必要がある

   client/
   |- dist/
   |  |- assets/
   |  |  |- index-*.js
   |  |  |- index-*.css
   |  |  |- ...
   |  |- index.html
   |  |- ...
   |- ...
   

   • 静的リソースはstaticディレクトリ内に配置することで、バックエンドAPIから提供される
   • 基本的には、distディレクトリ内のファイルをそのままstaticディレクトリ内にコピーする
   • dist/assets/index-*.jsのようなjsファイルは、staticディレクトリ直下に移動またはコピーする
     • build時に環境変数でプレースホルダー{{.VITE_API_URL}}を埋め込んでいるため、staticディレクトリ内に配置したjsファイルはテンプレートとなりサーバー起動時に、static/assets/内にサーバー側の環境変数VITE_API_URLの値が埋め込まれたjsファイルが生成される

   static/
   |- assets/
   |  |- index-*.js  <-テンプレートエンジンによって環境変数が置換されたjsファイル
   |  |- index-*.css
   |  |- ...
   |- index.html
   |- index-*.js  <-dist/assets/index-*.jsを移動またはコピーしたテンプレートjsファイル
   |- ...
   

バックエンドのビルド

1. wireというDIツールを使用しているため、go buildする際は以下のコマンドでwire_gen.goをbuild対象に含める必要がある
   • icon.sysoが用意されているため、-oオプションを使用して生成されるexeファイルのアイコンとして指定すること

   go build -o main.go wire_gen.go
   

サーバーの起動

1. serverディレクトリ内の.envファイルを適切に設定する
2. 以下のコマンドを実行する
   • 0.0.0は適切なバージョンに置き換えること
   • --migrateオプションを付けることで、DBのマイグレーションを実行する
   • --tmplオプションを付けることで、staticディレクトリ内のテンプレートjsファイルからstatic/assets内にjsファイルを生成する

   server-0.0.0.exe --migrate
   server-0.0.0.exe tmpl
   

3. サーバーの起動
   • 0.0.0は適切なバージョンに置き換えること

   server-0.0.0.exe
   

4. その他のオプション
   • 0.0.0は適切なバージョンに置き換えること
   • --seedオプションを付けることで、DBのシードデータを投入する
   • --resetオプションを付けることで、DBのテーブル全削除を実行する
     • --resetオプション実行後は、--migrateオプションを付けてサーバーを起動すること
5. 開発時(ビルド前)は以下のコマンドでサーバーを起動すること
   • オプションは上記と同様

   go run main.go wire_gen.go