Merge pull request #208 from HiEventsDev/develop

main <- develop
HiEventsDev · Sep 12, 2024 · 66357fa · 66357fa
2 parents aa360d7 + 6943f28
commit 66357fa
Show file tree

Hide file tree

Showing 46 changed files with 1,133 additions and 442 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,2 +1,3 @@
 github: HiEventsDev
 buy_me_a_coffee: hi.events
+open_collective: hievents
diff --git a/INSTALL_WITHOUT_DOCKER.md b/INSTALL_WITHOUT_DOCKER.md
@@ -0,0 +1,223 @@
+# Running Hi.Events Locally Without Docker
+
+This guide provides instructions for setting up Hi.Events locally without using Docker, including the necessary prerequisites,
+setup steps, and configuration details.
+
+**For a faster and more reliable setup, we strongly recommend using the official [Docker setup](https://hi.events/docs/getting-started/quick-start).**
+
+## Prerequisites
+
+1. [Install PHP 8.2 or higher](https://www.php.net/downloads.php)
+2. [Install Composer](https://getcomposer.org/download/)
+3. [Install PostgreSQL](https://www.postgresql.org/download/)
+4. [Install Node.js](https://nodejs.org/en)
+5. [Install Yarn](https://yarnpkg.com/getting-started/install)
+
+### PHP Extensions
+
+Ensure the following PHP extensions are installed: `gd`, `pdo_pgsql`, `sodium`, `curl`, `intl`, `mbstring`, `xml`, `zip`, `bcmath`.
+
+## Setup
+
+First, fork the repository and clone it locally:
+
+```bash
+git clone https://github.com/youraccount/Hi.Events.git
+```
+
+Hi.Events has two main directories: `backend` (Laravel) and `frontend` (React).
+
+### Backend Setup
+
+1. **Create the `.env` file:**
+
+   Navigate to the `backend` directory and copy the example `.env` file:
+
+   ```bash
+   cd backend
+   cp .env.example .env
+   ```
+
+2. **Database Configuration:**
+
+   Update the `.env` file with your database credentials:
+
+   ```bash
+   DB_CONNECTION=pgsql
+   DB_HOST=localhost
+   DB_PORT=5432
+   DB_DATABASE=postgres
+   DB_USERNAME=postgres
+   DB_PASSWORD=postgres
+   ```
+
+   This assume the default PostgreSQL configuration. Update the values as needed.
+
+3. **Mail Server Configuration:**
+
+   Configure Mailtrap for email handling, or use the `log` driver to log emails locally:
+
+   ```bash
+   MAIL_MAILER=smtp
+   MAIL_HOST=smtp.mailtrap.io
+   MAIL_PORT=2525
+   MAIL_USERNAME=your_mailtrap_username
+   MAIL_PASSWORD=your_mailtrap_password
+   MAIL_ENCRYPTION=tls
+   MAIL_FROM_ADDRESS=your_email
+   MAIL_FROM_NAME="${APP_NAME}"
+
+   # Alternatively use just this value to log emails locally:
+   MAIL_MAILER=log
+   ```
+
+4. **URL Configuration:**
+
+   Set the application and frontend URLs in the `.env` file:
+
+   ```bash
+   APP_URL=http://localhost
+   APP_PORT=8000
+   APP_FRONTEND_URL=http://localhost:5678
+   ```
+
+5. **Install Dependencies:**
+
+   Install the backend dependencies:
+
+   ```bash
+   composer install
+   ```
+
+6. **Generate Application Key:**
+
+   Generate the Laravel application key:
+
+   ```bash
+   php artisan key:generate
+   ```
+
+7. **Run Migrations:**
+
+   Run the database migrations:
+
+   ```bash
+   php artisan migrate
+   ```
+
+8. **Configure File Storage:**
+
+   Set the following values in your `.env` file:
+
+   ```bash
+   FILESYSTEM_PUBLIC_DISK=public
+   FILESYSTEM_PRIVATE_DISK=local
+   APP_CDN_URL=http://localhost:8000/storage
+   ```
+
+   Then create a symbolic link for storage:
+
+   ```bash
+   php artisan storage:link
+   ```
+
+9. **Start the Backend Server:**
+
+   Start the Laravel development server:
+
+   ```bash
+   php artisan serve
+   ```
+
+   Visit `http://localhost:8000` to verify the backend is running.
+
+10. **Optional: Configure Stripe (for Payment Integration):**
+
+If you want to test the payment functionality, configure Stripe:
+
+```bash
+STRIPE_PUBLIC_KEY=your_public_key
+STRIPE_SECRET_KEY=your_secret_key
+STRIPE_WEBHOOK_SECRET=your_webhook_secret
+```
+
+### Frontend Setup
+
+#### 1. **Create the `.env` File:**
+
+Navigate to the `frontend` directory and copy the example `.env` file:
+
+   ```bash
+   cd frontend
+   cp .env.example .env
+   ```
+
+#### 2. **Configure Frontend `.env`:**
+
+Update the `.env` file with the following settings:
+
+   ```bash
+   VITE_API_URL_CLIENT=http://localhost:8000
+   VITE_API_URL_SERVER=http://localhost:8000
+   VITE_FRONTEND_URL=http://localhost:5678
+   VITE_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXX
+   ```
+
+#### 3. **Install Dependencies:**
+
+Install the frontend dependencies:
+
+   ```bash
+   yarn install
+   ```
+
+#### 4. **Set Environment Variables:**
+
+Set the environment variables before starting the frontend app.
+
+- **Windows:**
+
+  ```bash
+  $env:VITE_API_URL_CLIENT="http://localhost:8000"
+  $env:VITE_API_URL_SERVER="http://localhost:8000"
+  $env:VITE_FRONTEND_URL="http://localhost:5678"
+  $env:VITE_STRIPE_PUBLISHABLE_KEY="pk_test_XXXXXXXX"
+  ```
+
+- **Linux/Mac:**
+
+  ```bash
+  export VITE_API_URL_CLIENT="http://localhost:8000"
+  export VITE_API_URL_SERVER="http://localhost:8000"
+  export VITE_FRONTEND_URL="http://localhost:5678"
+  export VITE_STRIPE_PUBLISHABLE_KEY="pk_test_XXXXXXXX"
+  ```
+
+#### 5. **Build and Start the Frontend:**
+
+Run the following commands to build and start the frontend application:
+
+   ```bash
+   yarn build
+   yarn start
+   ```
+
+Visit `http://localhost:5678` to view the frontend.
+
+## Troubleshooting
+
+1. **Composer Install Errors:**  
+   Ensure the required PHP extensions are installed. Check by running:
+
+   ```bash
+   php -m
+   ```
+
+2. **Database Connection Issues:**  
+   Verify the database credentials in the `.env` file and ensure the PostgreSQL service is running.
+
+3. **Mail Server Errors:**  
+   Ensure that your mail server credentials (e.g., Mailtrap) are correct or use the `log` driver for local email logging.
+
+4. **Frontend not connecting to the backend:**  
+   Ensure the API URLs are set correctly in both the frontend `.env` file and the backend `.env` file. Also, verify that environment variables are properly exported in the terminal.
diff --git a/README.ja.md b/README.ja.md
@@ -0,0 +1,126 @@
+<p align="center">
+  <img src="https://hievents-public.s3.us-west-1.amazonaws.com/website/hi-events-rainbow.png?v=1" alt="Hi.Events ロゴ" width="200px">
+</p>
+<h3 align="center">Hi.Events</h3>
+<p align="center">
+<a href="https://demo.hi.events/event/1/dog-conf-2030">デモイベント 🌟</a> <a href="https://hi.events?utm_source=gh-readme">ウェブサイト 🌎</a>  <a href="https://hi.events/docs">ドキュメント 📄</a>  <a href="https://hi.events/docs/getting-started?utm_source=gh-readme">インストール ⚙️</a>
+</p>
+
+<h3 align="center">
+ 簡単にイベントを管理し、オンラインでチケットを販売します。
+</h3>
+
+<div align="center">
+
+[![Hi.Events ドキュメント](https://img.shields.io/badge/docs-hi.events-blue)](https://hi.events/docs)
+[![ライセンス: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://github.com/HiEventsDev/hi.events/LICENCE)
+[![GitHub リリース](https://img.shields.io/github/v/release/HiEventsDev/hi.events?include_prereleases)](https://github.com/HiEventsDev/hi.events/releases)
+[![ユニットテストの実行](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml/badge.svg?event=push)](https://github.com/HiEventsDev/hi.events/actions/workflows/unit-tests.yml)
+[![Docker ダウンロード数](https://img.shields.io/docker/pulls/daveearley/hi.events-all-in-one)](https://hub.docker.com/r/daveearley/hi.events-all-in-one)
+
+</div>
+
+<div align="center">
+ 🌟 スターを付けていただけると嬉しいです！ 🌟
+</div>
+
+<hr/>
+
+## 目次
+
+- [紹介](#-紹介)
+- [機能](#-機能)
+- [クイックスタート](#-クイックスタート)
+- [変更履歴](#-変更履歴)
+- [貢献](#-貢献)
+- [FAQ](#-faq)
+
+## 📚 紹介
+
+<a href="https://hi.events">Hi.Events</a> は、機能豊富な自ホスト型イベント管理およびチケット販売プラットフォームです。会議からクラブナイトまで、Hi.Events はあらゆる規模のイベントの作成、管理、チケット販売を支援するように設計されています。
+
+<img alt="Hi.Events 自ホスト型チケット販売ダッシュボード" src="https://hievents-public.s3.us-west-1.amazonaws.com/website/dashboard-screenshot.png"/>
+
+## 🌟 機能
+
+<a href="https://hi.events">Hi.Events</a> は、イベント管理とチケット販売を効率化するための機能が満載です：
+
+- 📊 **イベント分析:** イベントのパフォーマンスとチケット販売に関する深い洞察を得る。
+- 🎟 **埋め込み可能なチケットウィジェット:** チケット販売を簡単に任意のウェブサイトに統合。
+- 🖥 **カスタマイズ可能なイベントホームページ:** 柔軟なデザインオプションで目を引くイベントページを作成。
+- 🔑 **直感的なチェックインツール:** Hi.Events の QR コードチェックインツールで簡単に参加者をチェックイン。
+- 💬 **イベントメッセージングツール:** 重要な更新やリマインダーを参加者に送信。
+- 📝 **カスタム注文フォーム:** チェックアウト時にカスタマイズされた質問で参加者情報を収集。
+- 🎫 **複数のチケットタイプ:** 無料、有料、寄付、または階層型のチケットタイプ。
+- 💸 **多用途なプロモコード:** 高度に多用途な割引コード。先行販売アクセス、複数の割引オプション。
+- 💰 **即時支払い:** シームレスな Stripe 統合で即時支払いを楽しむ。
+- 🧾 **税金と手数料の設定:** チケットごとに税金と手数料を追加。
+- 📦 **データエクスポート:** 参加者と注文データを XLSX または CSV にエクスポート。
+- 💻 **REST API:** カスタム統合のためのフル機能の REST API。
+- 🔍 **SEO ツール:** 各イベントの SEO 設定をカスタマイズ。
+- 🛒 **美しいチェックアウトプロセス:** スムーズで美しいチェックアウト体験を確保。
+- 🔐 **役割ベースのアクセス:** 複数のユーザーロールをサポート。
+- 💻 **オンラインイベントサポート:** オンラインイベントの指示とリンクを提供。
+- ⏪ **全額および部分的な払い戻しサポート:** 全額および部分的な払い戻しを簡単に管理。
+- 📧 **メール通知:** 自動メール通知で参加者を最新情報に保つ。
+- 📱 **モバイル対応:** どのデバイスでもシームレスな体験を楽しむ。
+- 🌐 **多言語サポート:** 複数の言語をサポート。
+- 🎉 **その他多数！**
+
+## 🚀 クイックスタート
+
+詳細なインストール手順については、[ドキュメント](https://hi.events/docs/getting-started) を参照してください。クイックスタートのために、以下の手順に従ってください：
+
+### ワンクリックデプロイ
+
+[![DigitalOcean でデプロイ](https://www.deploytodo.com/do-btn-blue.svg)](https://github.com/HiEventsDev/hi.events-digitalocean)
+
+[![Render でデプロイ](https://render.com/images/deploy-to-render-button.svg)](https://github.com/HiEventsDev/hi.events-render.com)
+
+[![Railway でデプロイ](https://railway.app/button.svg)](https://railway.app/template/8CGKmu?referralCode=KvSr11)
+
+[![Zeabur でデプロイ](https://zeabur.com/button.svg)](https://zeabur.com/templates/8DIRY6)
+
+### 🐳 Docker を使用したクイックスタート
+
+> [!重要]  
+> システムに Docker および Docker Compose がインストールされていることを確認してください。インストールされていない場合は、公式 Docker ウェブサイトからダウンロードできます：[Docker](https://www.docker.com/get-started)。
+
+1. **リポジトリをクローン：**
+   ```bash
+   git clone git@github.com:HiEventsDev/hi.events.git
+   ```
+
+2. **Docker ディレクトリに移動：**
+   ```bash
+   cd hi.events/docker/all-in-one
+   ```
+
+3. **Docker コンテナを起動：**
+   ```bash
+   docker compose up -d
+   ```
+4. **アカウントを作成：**
+   ```bash
+   ブラウザを開き、http://localhost:8123/auth/register に移動します。
+   ```
+
+ℹ️ 他のインストール方法や、プロダクションまたはローカル開発環境の設定については、[クイックスタートガイド](https://hi.events/docs/getting-started) を参照してください。
+
+## 📝 変更履歴
+
+継続的な改善と機能追加については、[GitHub リリースページ](https://github.com/HiEventsDev/hi.events/releases) をご覧ください。
+
+## 🤝 貢献
+
+貢献、提案、バグ報告を歓迎します！新しい機能や拡張を提案する前に、ディスカッションのために issue を開いてください。
+
+## ❓ FAQ
+
+質問がありますか？[ドキュメント](https://hi.events/docs) に答えがあります。探しているものが見つからない場合は、[hello@hi.events](mailto:hello@hi.events) までお気軽にお問い合わせください。
+
+## 📜 ライセンス
+
+Hi.Events は [AGPL-3.0](https://github.com/HiEventsDev/hi.events/blob/main/LICENCE) ライセンスの条件に基づいてライセンスされています。
+
+商用ライセンスオプションを含むライセンス情報の詳細については、[こちら](https://hi.events/licensing) のライセンスページをご覧ください。