Skip to content

Latest commit

 

History

History
156 lines (103 loc) · 5.45 KB

README.md

File metadata and controls

156 lines (103 loc) · 5.45 KB
Raw

Getting Started with Development

Clone the Github repository

git clone https://github.com/wilford-woodruff-papers/wilford-woodruff-papers

Docker

If you'r enot using Herd Pro, then the other 2 local development options use Docker. You first need to install Docker Desktop or OrbStack for your operating system.

Options for Local Development

There are 3 supported options for doing local development:

Using Herd Pro

Herd is a recently released desktop application that handles configuring PHP and local development domains/SSL. Herd Pro is a paid version, but also include MySQL database and Meilisearch services so no additional software is required. This is the current recommended option for local development and includes other tools for monitoring sent email and debugging. Much of the documentation below if for setting up and running the application using legacies methods and can be ignored by following the Herd Pro documentation for running and configuring services.

Using Herd + Docker for Meilisearch

Since the project uses Meilisearch and Herd (Free version) doesn't include MEilisearch, you will need to run Meilisearch in a separate Docker container.

DBngin is a Mac only application that handles configuring MySQL and Redis.

You can then use the following connect parameters in your .env

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=wwp
DB_USERNAME=root
DB_PASSWORD=

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MEILISEARCH_HOST=http://meilisearch.orb.local:7700
MEILISEARCH_KEY="6DWfC5xQuDulEUhYjGGwVAS00tpZxKlPpc71Fkpr2CQ"

To start Meilisearch, run the following command to start Meilisearch in a Docker container

docker run -it --rm --name=meilisearch -p 7700:7700 -v ~/code/meilisearch/meili_data:/meili_data getmeili/meilisearch:v1.3 meilisearch --master-key="6DWfC5xQuDulEUhYjGGwVAS00tpZxKlPpc71Fkpr2CQ"

To start Qdrant, run the following command to start Qdrant in a Docker container

docker run -it --rm --name=qdrant -d -p 6333:6333 -v ~/code/qdrant_storage:/qdrant/storage:z qdrant/qdrant

Using Sail

Sail is a fully configured Docker environment for Laravel.

Installing Sail (Docker)

You may wish to configure a shell alias that allows you to execute Sail's commands more easily:

alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

Copy .env file to the root or your project directory

You can then use the following connect parameters in your .env

DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=wwp
DB_USERNAME=root
DB_PASSWORD=

REDIS_HOST=redis
REDIS_PASSWORD=null
REDIS_PORT=6379

MEILISEARCH_HOST=http://meilisearch:7700
MEILISEARCH_KEY=masterKey

RAY_HOST=host.docker.internal
RAY_PORT=23517
RAY_REMOTE_PATH='/var/www'
RAY_LOCAL_PATH='~/code/wilford-woodruff-papers'

Install PHP dependencies

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php82-composer:latest \
    composer install --ignore-platform-reqs

Setup of Sail and Installing Composer Dependencies

./vendor/bin/sail up

./vendor/bin/sail composer install

./vendor/bin/sail up or if you created the alias sail up

To make sure the packages are correct for the docker version of PHP run composer again

sail composer install

Install Node Modules

npm install

Assets are compiled using Lasso during deployment. To compile assets locally, run one of the following:

npm run dev
npm run watch
npm run prod

Import the sample database

Edit hosts file

OSX sudo nano /private/etc/hosts

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

If you don't feel like reading, Laracasts can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.