Awesome

vagrant box add laravel/homestead

then clone the box with git clone https://github.com/laravel/homestead.git ~/Homestead

You should now have a "Homestead" folder on your machine at ~/Users/You/Homestead

ip: "192.168.10.10"
memory: 2048
cpus: 1
provider: virtualbox

authorize: ~/.ssh/id_rsa.pub

keys:
    - ~/.ssh/id_rsa

folders:
    - map: ~/Code
      to: /home/vagrant/Code

sites:
    - map: olm.test
      to: /home/vagrant/Code/openlittermap-web/public

databases:
    - olm
    - olm_test

features:
    - mysql: true
    - minio: true

buckets:
    - name: olm-public
      policy: public
    - name: olm-public-bbox
      policy: public

Next, update your hosts file on your host machine (sudo nano /etc/hosts on windows it's C:\Windows\System32\Drivers\etc\hosts) and include 192.168.10.10 olm.test

When you want to boot up the VM, cd into the Homestead folder on your host machine and run vagrant up

~/Users/You/Code/openlittermap-web

If this is your first time installing, you need to run vagrant provision

Locally, run npm install

SSH into the VM with vagrant ssh. cd into Code/openlittermap-web, and then run composer install You can migrate and seed the tables with php artisan migrate --seed

Once you're done, run npm run watch which will build the project into the public folder.

You should now be able to open the browser and visit olm.test

If you would like to contribute something, make a new branch locally git checkout -b feature/my-new-feature. We would love to see your pull requests!

In your .env file, add "WEBSOCKET_BROADCAST_HOST=192.168.10.10"
In broadcasting.php, change 'host' => env('WEBSOCKET_BROADCAST_HOST')
In one window, run `php artisan websockets:serve --host=192.168.10.10`
Then, in another window, run `php artisan horizon`
To test it's working, open another window. Open tinker and run event new(\App\Events\UserSignedUp(1));

If you would want to generate some dummy photos for development purposes, you can do so by using the php artisan olm:photos:generate-dummy-photos command to generate 1500 dummy photos. It also takes arguments so you can do for e.g. php artisan olm:photos:generate-dummy-photos 2000 and 2000 photos will be generated. After running the above command, run php artisan clusters:generate-all and the photos should be visible in the Global Map tab and in http://olm.test/world/Ireland/County%20Cork/Cork/map

The project uses AWS S3 to store photos on production. On development, however, it uses Minio, an open source object storage server with an Amazon S3 compatible API. If you copied the .env.example file into .env you should be able to access the Minio control panel at http://192.168.10.10:9600 (homestead:secretkey). Remember to update the Access Policy to public for your buckets, on the admin panel.