Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️
PHP attendize-alternativedoor-managementevent-check-inevent-managementevent-registrationevent-ticketingeventbrite-alternativeeventslaravelopen-sourcephpreactself-hostedsell-ticketssell-tickets-onlineticket-sellingticketing-systemtickettailor-alternativetito-alternative
Update instructions
Dave Earley174210576f86
diff --git a/INSTALL_WITHOUT_DOCKER.md b/INSTALL_WITHOUT_DOCKER.mdnew file mode 100644index 000000000..c924efce5--- /dev/null+++ 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/frontend/src/utilites/config.ts b/frontend/src/utilites/config.tsindex 3c5bda272..822fb415c 100644--- a/frontend/src/utilites/config.ts+++ b/frontend/src/utilites/config.ts@@ -8,6 +8,6 @@ export const getConfig = (key: ConfigKeys): string | undefined => {return serverEnv[key] as string | undefined;}- const clientEnv = typeof window !== "undefined" && window.hievents ? window.hievents : {...import.meta.env};+ const clientEnv = typeof window !== "undefined" && window.hievents ? window.hievents : {};return clientEnv[key];};diff --git a/install locally/LOCAL.md b/install locally/LOCAL.mddeleted file mode 100644index 51b6f5376..000000000--- a/install locally/LOCAL.md+++ /dev/null@@ -1,227 +0,0 @@-# Running HI.Events locally--## Prerequisites--1. [Install PHP 8.2 or higher](https://www.php.net/downloads.php)-2. [Install Composer](https://getcomposer.org/download/)-3. Install Postgres-4. [Install Node.js LTS and yarn](https://nodejs.org/en)--### Php Extensions--Make sure you have the following PHP extensions installed:--1. gd-2. pdo_pgsql-3. sodium-4. curl-5. intl-6. mbstring-7. xml-8. zip-9. bcmath--If you don't have them installed, you can go to the `php.ini` file and uncomment the lines that contain the extensions by removing the `;` at the beginning of the line.--## Setup--First, fork the repository and clone it to your local machine. You can do this by running the following command in your terminal:--```bash-git clone https://github.com/youraccount/Hi.Events.git--```--The project has two main directories: `backend` and `frontend`. The `backend` directory contains the Laravel application, and the `frontend` directory contains the React JS application.--### Server Setup--1. Before running the application, you need to create a `.env` file in the root directory of the project. You can copy the `.env.example` file and rename it to `.env`.--```bash-cd backend-cp .env.example .env-```--2. Configure the database connection in the `.env` file. You can use the following configuration:--```bash-DB_CONNECTION=pgsql-DB_HOST=localhost-DB_PORT=5432-DB_DATABASE=anynamethatyouwant-DB_USERNAME=yourusername-DB_PASSWORD=yoursecretpassword-```--3. Configure the mail server in the `.env` file. You can use the following configuration:--```bash-MAIL_MAILER=smtp-MAIL_HOST=smtp.mailtrap.io-MAIL_PORT=2525-MAIL_USERNAME=youremail-MAIL_PASSWORD=yourpassword-MAIL_ENCRYPTION=tls-MAIL_FROM_ADDRESS=youremail-MAIL_FROM_NAME="${APP_NAME}"-```--Note that you can use any mail server you want. In this example, we are using Mailtrap. You can create an account on [Mailtrap](https://mailtrap.io/) and get the SMTP credentials.--4. Configure the URLs in the `.env` file. You can use the following configuration:--```bash-APP_URL=http://localhost-APP_PORT=8000-APP_FRONTEND_URL=http://localhost:*-```--Note that the `APP_FRONTEND_URL` is set to `http://localhost:*` to ensure that the frontend can access the backend and will not be blocked by CORS.--5. Add the frontend URL to the `CORS` configuration in the .env file:--```bash-CORS_ALLOW_ORIGIN=http://localhost:5678-```--6. Install the project dependencies by running the following command:--```bash-composer install-```--7. Create a new database in Postgres with the name you specified in the `.env` file.--8. Run the following command to generate the application key:--```bash-php artisan migrate-```--9. Run the following command to start the server:--```bash-php artisan serve-```--You should see the following screen when you open the browser and navigate to `http://localhost:8000`:---10. Set up Stripe by creating an account on [Stripe](https://stripe.com/). After creating an account, you can get the publishable key and secret key from the dashboard.--```bash-STRIPE_PUBLIC_KEY=yourpublickey-STRIPE_SECRET_KEY=yoursecretkey-STRIPE_WEBHOOK_SECRET=yoursecret-```--### Frontend Setup--1. Go to the `frontend` directory and create a `.env` file by copying the `.env.example` file:--```bash-cd frontend-cp .env.example .env-```--2. Configure 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_51Ofu1CJKnXOyGeQuDPUHiZcJxZozRuERiv4vQRBtCscwTbxOL574cxUjAoNRL2YLCumgC5160pl6kvTIiAc9mOeM0058KAWQ55-```--3. Install the project dependencies by running the following command:--```bash-yarn install-```--4. Set up the environment variables in the terminal:--#### For 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_51Ofu1CJKnXOyGeQuDPUHiZcJxZozRuERiv4vQRBtCscwTbxOL574cxUjAoNRL2YLCumgC5160pl6kvTIiAc9mOeM0058KAWQ55"-```--#### For 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_51Ofu1CJKnXOyGeQuDPUHiZcJxZozRuERiv4vQRBtCscwTbxOL574cxUjAoNRL2YLCumgC5160pl6kvTIiAc9mOeM0058KAWQ55"-```--5. Run the following commands to start the frontend application.--```bash-yarn build-yarn start-```--### Client Side Rendering--If you want to run the application in Client Side Rendering mode, you can run the following command (Development mode):--```bash-yarn dev:csr-```--Now you can open the browser and navigate to `http://localhost:5678` to see the application running.------Instead, if you want to run the application in Production mode, you can run the following command:--```bash-yarn build:csr-yarn preview:csr-```--You can open the browser and navigate to `http://localhost:4173` to see the application running.--### Server Side Rendering--1. Set up the environment variables in the terminal, as shown in the Frontend Setup section.--2. Run the following command to start the frontend application in server-side rendering mode (Development mode):--```bash-yarn dev:ssr-```--Now you can open the browser and navigate to `http://localhost:5678` to see the application running.------Instead, if you want to run the application in Production mode, you can run the following command:--```bash-yarn build:ssr-yarn preview:ssr-```--You can open the browser and navigate to `http://localhost:4173` to see the application running.--## Troubleshooting--1. **Composer Install Error:** If you encounter an error while running `composer install`, ensure that you have the required PHP extensions installed. You can check the PHP extensions by running the following command:--```bash-php -m-```--2. **Database Connection Error:** If you encounter a database connection error, ensure that the database credentials in the `.env` file are correct. Check that the database server is running and that the database exists.--3. **Mail Server Error:** If you encounter an error with the mail server configuration, ensure that the mail server settings in the `.env` file are correct. Check that the mail server is running and that the SMTP credentials are valid.--4. **Frontend is not connecting to the backend:** If the frontend is not connecting to the backend, ensure you set the correct URLs in the `.env` file for both the backend and frontend. Ensure you set the environment variables correctly in the terminal for SSR.--5. **CORS Error:** If you encounter a CORS error, ensure that the CORS configuration in the `backend/.env` file allows the frontend URL. Check that the frontend URL is set correctly in the `.env` file.diff --git a/install locally/image.png b/install locally/image.pngdeleted file mode 100644index c0ffc6a51..000000000Binary files a/install locally/image.png and /dev/null differ