Skip to content
/ accommo Public

list accommodations is NSW, sydney area using vue spa and php via ATLAS api

Notifications You must be signed in to change notification settings

gitmaz/accommo

Repository files navigation

@@@ Installing backend:
   via locally installed php 8.2 and composer
    open a terminal
    cd backend
    composer install

@@@ Installing frontend:
   via locally installed node 14
    open a terminal
    cd frontend
    npm install

@@@ running spa
  via locally installed php 8.2 and node 14 (using separate terminal windows):
    cd backend
    serve.bat (on Windows)
    . ./serve.sh (on unix based machines)

    cd frontend
    npm run serve

    wait until http://localhost:8080/ appears , then you can go to that url to run the app

  via docker:

   IMPORTANT: making installation of libraries in backend is not yet possible via docker, to
        achieve that, we need to use this image: composer:2 and we should run this command in docker-compose.yml:
        sh -c "composer install && php -S 0.0.0.0:8000 -t public"
        as a workaround you need to do composer install in backend folder using your locally installed composer.
        Please follow below steps when you installed vendor dir, to run tha application via docker.

   on the root do:
    docker-compose up -d  (spins up the containers for both backend and frontend)
    docker-compose down   (shuts down the containers for both backend and frontend)

    Note: it takes a while for the container to run (specially frontend), either wait or run it in detached mode and
    wait until - Local:   http://localhost:8080/ appears , then you can go to that url to run the app



@@@ running unit tests
 on Unix based systems:
  cd backend
  vendor/bin/phpunit SydneyAreasControllerTest.php
   or
  vendor/bin/phpunit tests/AccommodationsControllerTest.php
   or for running all tests:
  vendor/bin/phpunit

 on Windows:
  cd backend
  php vendor/bin/phpunit tests/SydneyAreasControllerTest.php
   or
  php vendor/bin/phpunit tests/AccommodationsControllerTest.php
   or for running all tests:
  php vendor/bin/phpunit

@@@ design note:
  I have used the areas endpoint from ATLAS to find out which areas is in Sydney by filtering word "Sydney" which is a bit
  risky if in future other areas without having Sydney as part of their name will be added. It is safer to use /locations
  endpoint and filter by DomesticAreaName=='Greater Sydney'. The LocationsController can be consulted in a SydneyAreasController
  if that needs to be implemented.

About

list accommodations is NSW, sydney area using vue spa and php via ATLAS api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published