Skip to content

INSTALL.md

Latest commit

 

History

History
94 lines (64 loc) · 2.52 KB

INSTALL.md

File metadata and controls

94 lines (64 loc) · 2.52 KB

WOW-BE Installation Guide

OAuth configuration

Google

Documentation: https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid

  1. Go to the Google Console: https://console.cloud.google.com/
  2. Create a new project: https://console.cloud.google.com/projectcreate
  3. Go to https://console.cloud.google.com/apis/credentials
  4. Click on "Create Credentials" and select "OAuth client ID".
  5. Select "Web application" as the application type.
  6. Add the following authorized redirect URIs:
    • http://localhost:8000/auth/google/callback
    • https://your-domain.com/auth/google/callback
  7. Click "Create" and copy the Client ID and Client Secret.

GitHub

Documentation: https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app

  1. Go to the your Developer settings: https://github.com/settings/developers
  2. Click on "New OAuth App".
  3. Fill in the application name, homepage URL, and description.
  4. Set the authorization callback URL to:
    • http://localhost:8000/auth/github/callback
    • https://your-domain.com/auth/github/callback
  5. Click "Register application" and copy the Client ID and Client Secret.

Run locally

Start the application

Use PHP Built-in Server

Copy the .env.example file to .env and set your environment variables accordingly.

Then run the following command to start the PHP built-in server:

php artisan serve

Use Laravel Octane

Copy the .env.example file to .env and set your environment variables accordingly.

Then run the following command to start the Laravel Octane server:

php artisan octane:frankenphp

Use Docker

Copy the .env.example file to .env and set your environment variables accordingly.

Then run the following command to build and run the Docker container:

docker build --tag wow-be --label "project=wow-be" .
docker run --publish 8000:8000 --env-file .env --detach wow-be

Use Docker Compose

Set your environment variables accordingly in the .env.example file.

Then run the following command to start the Docker containers:

docker compose up --build --force-recreate --detach

Tip

If you want to run it with a PostgreSQL database, you can use the docker-compose-local.yml file:

docker compose -f docker-compose-local.yml up --build --force-recreate --detach

Finalize the installation

php artisan migrate
php artisan optimize

If you need some sample data, you can run:

php artisan db:seed