search

Galleme / backend

0 stars 0 forks source link

readme

Galleme (backend)

build status code quality code coverage latest release issue status

Prerequisites

Composer

See Composer Getting Started

Installation

Docker

In order to run the backend on Docker, you will have to run Docker on your device (linux, mac or windows with WSL enabled)

  1. Run docker run --rm \ -u "$(id -u):$(id -g)" \ -v $(pwd):/var/www/html \ -w /var/www/html \ laravelsail/php80-composer:latest \ composer install --ignore-platform-reqs
  2. (optional) Create a sail alias using alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail' else you'd have to always call ./vendor/bin/sail

Staring & Stopping

  1. Run sail up to start
  2. Run sail down to stop

Sail Usage

See Sail Guide for more information about using Sail.

Important Notes

For Windows Users
  1. Ensure WSL is enabled on Docker in case of any docker issues.
  2. In case you get a getcwd() error or "no such file or directory found" error when executing sail type cd $(pwd) such that getcwd() symlinking will work properly again.

Manually

Prerequisites

  1. PHP with Composer
  2. Any Laravel Supported Database (docker container uses MariaDB)
  3. Meilisearch
  4. Redis

Installation

  1. Run composer install
  2. rename .env.example to .env
  3. Setup the .env file correctly (url, database credentials, redis credentials, etc...)
  4. Run php artisan serve
  5. Go to the url displayed on the terminal