https://github.com/dannyyassine/docker-octane-vue

Skeleton project to get started with laravel-octane and vue in a docker-compose env using gitpod or codespaces.
https://github.com/dannyyassine/docker-octane-vue

docker docker-compose gitpod gitpod-workspace laravel octane openswoole php postgres supabase swoole typescript vue vuejs

Last synced: about 1 month ago
JSON representation

Skeleton project to get started with laravel-octane and vue in a docker-compose env using gitpod or codespaces.

• Host: GitHub
• URL: https://github.com/dannyyassine/docker-octane-vue
• Owner: dannyYassine
• Created: 2021-06-06T20:08:48.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-23T18:00:15.000Z (over 1 year ago)
• Last Synced: 2023-09-24T20:03:37.761Z (over 1 year ago)
• Topics: docker, docker-compose, gitpod, gitpod-workspace, laravel, octane, openswoole, php, postgres, supabase, swoole, typescript, vue, vuejs
• Language: HTML
• Homepage:
• Size: 2.57 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docker-octane-vue

Simple skeleton project in order to quickly start a new project with the following technologies with docker-compose and  [gitpod](https://www.gitpod.io):

* laravel with octane (swoole)

* vue (with typescript)

* postgres




  

    



        

    


    



        

    

    



        

    


  

Technologies:

* [laravel](https://laravel.com/)

* [laravel octane](https://laravel.com/docs/9.x/octane#main-content)

* [vue](https://vuejs.org/)

* [typescript](https://www.typescriptlang.org/)

* [postgres](https://www.postgresql.org/)

* [gitpod](https://www.gitpod.io/)

* [supabase](https://supabase.com/)

## Develoment

* Ready to use docker-compose.yml

  or

  

* CDE using [Gitpod](https://www.gitpod.io/)

## Structure

Each technology is containerized for easy development

    * Backend: laravel-octane with swoole

    * Worker: laravel queue

    * Frontend: vue client

    * Database: postgres

## Auto refresh

While the containers are running, the backend and frontend will auto refresh when making changes to the application code. No need to rebuild the containers.

# Getting Started

## Using docker-compose locally

##### Build the containers

```bash

make build

```

##### Start developing

```bash

make dev

```

##### While the containers are running, migrate the database

```bash

make migrate

```

## Using gitpod

#### Workspace

Simply start the workspace with this project, eveyrthing is configured in .gitpod.yml

# Deploy options

The options below are free, great for getting things started, and very easy to scale up with their paid plans.

## Backend

* Render https://render.com/docs/web-services

## Database

* Supabase https://supabase.com

## Frontend

* Firebase https://firebase.google.com/docs/hosting

* Render https://render.com/docs/static-sites

## Examples

### Deploying to render

while using `render.yaml` https://render.com/docs/blueprint-spec

```

# A web service

  - type: web

    name: api

    env: docker

    dockerfilePath: ./deploy/php.api.dockerfile # optional

    dockerContext: ./api # optional

    

# A background worker that consumes a queue

  - type: worker

    name: queue

    env: docker

    dockerfilePath: ./deploy/php.queue.dockerfile # optional

    dockerContext: ./api # optional

    

# A static site for the vue app

  - type: web

    name: docker-octane-vue-client

    env: static

    branch: master

    buildCommand: cd client && yarn && yarn build

    staticPublishPath: ./client/dist

    routes:

      - type: rewrite

        source: /*

        destination: /index.html

```

## PhpUnit on VsCode

#### Update settings.json

update the key in `better-phpunit.docker.paths` to the local path of this project on your machine.

```json

"better-phpunit.docker.paths": {

     "/api": "/usr/src/api"

},

```

## Debugging with xdebug

* inside xbude.ini, VS code in codespaces, we need to change `xdebug.client_host`

* run `hostname -I | cut -d ' ' -f1` in order to get the ip address of the codespace within the codespace main terminal.

* set it like: xdebug.client_host=172.16.5.4

* you only set it `xdebug.client_host=host.docker.internal` when you are running VS code in the app, locally.

## Github codespaces useful links (if you want to use codespaces instead)

* [devcontainer.json specs](https://containers.dev/implementors/json_reference/)

* [docker-compose example](https://github.com/microsoft/vscode-dev-containers/blob/main/container-templates/docker-compose/.devcontainer/devcontainer.json)

* [intro to codespaces](https://dev.to/pwd9000/introduction-to-github-codespaces-building-your-first-dev-container-69l)