https://github.com/diamondlightsource/synchweb-devel-env
synchweb development environment
https://github.com/diamondlightsource/synchweb-devel-env
Last synced: 5 months ago
JSON representation
synchweb development environment
- Host: GitHub
- URL: https://github.com/diamondlightsource/synchweb-devel-env
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2018-10-31T13:51:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-07T09:50:39.000Z (about 1 year ago)
- Last Synced: 2025-02-07T10:31:49.344Z (about 1 year ago)
- Language: Jinja
- Size: 87.4 MB
- Stars: 2
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SynchWeb Development Environment
## Introduction
This project allows you to generate a dev environment for SynchWeb - using either Vagrant or Podman.
* Instructions for setting up using Podman are available [here](./docs/Podman_instructions.md).
* Instructions for setting up using Vagrant are available [here](./docs/Vagrant_instructions.md).
Note, setting things up in a container via Podman is signficantly simpler, more lightweight and requires less external dependencies
(e.g. use of VirtualBox), so is the encouraged route.
## IDE Help
### Visual Studio
Plugins which are useful:
- [PHP Intelephense](ext:bmewburn.vscode-intelephense-client) Intellisense for PHP
- [Psalm](ext:bmewburn.vscode-intelephense-client) PHP Static analysis Typing
- Set script path: `"psalm.psalmScriptPath": "api/vendor/vimeo/psalm/psalm-language-server"`
- Add config path: `"psalm.configPaths": ["psalm.xml", "psalm.xml.dist", "api/psalm.xml",]`
## Troubleshooting
If errors are encountered along the way, it can be helpful to use `postman` to
isolate and diagnose these. This allows individual http requests to be created
and sent - which can be particularly helpful when invoking the backend API. If
errors are being returned from the PHP code, `print_r()` can be added to the
related code to return print statements in the http response.