Skip to content

Repository files navigation

Pinu Logo

🚧Pinu

ポートフォリオプロジェクト用のフルスタック開発環境

概要

このプロジェクトは、バックエンド(Go)とフロントエンド(単一 Next.js)を含むポートフォリオアプリケーションです。Task ランナーと Docker を利用して簡単に開発環境を構築できます。

前提条件

  • Docker
  • Task (インストールコマンド: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d)
  • Go 言語環境
  • Node.js と npm

セットアップ

初めてプロジェクトをセットアップする場合:

# Task ツールをインストール(初回のみ)
task install:task

# プロジェクトをセットアップ(環境変数、依存関係のインストール)
task setup

開発環境の起動

# 開発環境を起動(データベース、バックエンド、フロントエンド)
task start

# 開発環境一式(adminer含む)を起動
task dev

開発環境起動後、以下のURLでアクセスできます:

主要なタスク

タスク 説明
task setup 初期セットアップ(環境変数、依存関係のインストール)
task start 開発環境を起動(DB + バックエンド + フロントエンド)
task dev 開発環境一式起動(adminer含む)
task stop 開発環境を停止
task clean データベースを含めて完全に削除
task test 全体のテストを実行
task build 全体をビルド
task deploy:prep デプロイ準備(ビルド + テスト)
task fresh 完全に新しい状態で環境を起動

すべてのタスクを表示するには:

task --list

データベース

PostgreSQL データベースは Docker コンテナとして実行され、以下のデフォルト設定が適用されます:

  • データベース名: portfolio
  • ユーザー名: portfolio_user
  • パスワード: portfolio_pass
  • ポート: 5432

データベース関連のタスク:

task db:start    # PostgreSQLを起動
task db:stop     # PostgreSQLを停止
task db:reset    # データベースをリセット(全データ削除)
task db:logs     # PostgreSQLのログを表示

プロジェクト構造

.
├── backend/         # Goバックエンドコード
├── frontend/        # 単一 Next.js フロントエンド(client=/, admin=/admin)
├── database/        # データベース関連ファイル
│   ├── init/        # 初期化SQL
│   └── postgresql.conf  # PostgreSQL設定
├── docs/            # プロジェクトドキュメント
├── bin/             # ビルド生成物
├── compose.yml      # Docker Compose設定
├── Taskfile.yml     # Taskランナー設定
└── .env             # 環境変数(セットアップ時に作成)

ドキュメント

アクセシビリティ

フロントエンドのアクセシビリティに関する包括的なドキュメントは docs/ 配下を参照してください。

ライセンス

MIT License

About

toy ordering system for restaurants

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages