[DEPRECATED] PHPSW Website

See phpsw/phpsw-symfony5 for the replacement project.

Requirements

• Ansible 2.x (http://docs.ansible.com/ansible/intro_installation.html)
• Vagrant (https://www.vagrantup.com/docs/installation/)
• NFS

Getting started

1. Create a mapping in your hosts file from phpsw.local to 192.168.42.10.
2. vagrant up
3. vagrant ssh
4. cd /vagrant
5. yarn install (to install NPM dependencies).
6. cp app/config/secrets_template.yml app/config/secrets.yml
7. Update app/config/secrets.yml with your Meetup API key (not this is only needed if you want to use the entity generation scripts with meetup)

General Usage

To run the commands use /vagrant/runner.php

Validate data

To validate data: ./runner.php phpsw:validate-data

Generate data

There are a number of scripts to help generate the JSON data files. You can supply a meetup id and it will pull the data from meetup.

• Generate person: ./runner.php phpsw:generate-file-person <meetup-id> (meetup ID is optional, used to pull down as much data from Meetup as is available)

• Generate event: ./runner.php phpsw:generate-file-event <meetup-id>

• Generate all event files: ./data/scripts/generate-events.sh (Use with caution - this will re-generate all event files from meetup data but keep in mind that any manual edits which have been made to the existing event files will likely be lost. This script calls the phpsw:generate-file-event command for each event meetup ID from the list defined within.)

Build website

To generate website run the following steps on the VM

1. cd /vagrant
2. ./runner.php phpsw:generate-website
3. yarn dev or yarn watch to generate and watch.

Viewing generated content

Once you've generated the website point your broswer to (http://phpsw.local)

This assumes:

• VM is running
• local hosts is setup (see getting started)

Auto fixing coding standards

Prior to every commit execute composer cs-fix from within the VM. This will fix any code style issues.

CI

Execute composer ci from within the VM to run the CI tests locally.

Architecture

See the architecture.md file in the app directory for details on architecture.