microsoft / vscode-remote-try-php Goto Github PK

PHP sample project for trying out Dev Containers

Home Page: https://aka.ms/vscode-remote/containers/getting-started

License: MIT License

PHP 100.00%

vscode-remote-try-php's Introduction

Try Out Development Containers: PHP

A development container is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with GitHub Codespaces or Visual Studio Code Dev Containers.

This is a sample project that lets you try out either option in a few easy steps. We have a variety of other vscode-remote-try-* sample projects, too.

Note: If you already have a Codespace or dev container, you can jump to the Things to try section.

Setting up the development container

GitHub Codespaces

Follow these steps to open this sample in a Codespace:

Click the Code drop-down menu.
Click on the Codespaces tab.
Click Create codespace on main.

For more info, check out the GitHub documentation.

VS Code Dev Containers

If you already have VS Code and Docker installed, you can click the badge above or here to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

Follow these steps to open this sample in a container using the VS Code Dev Containers extension:

If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the getting started steps.
To use this repository, you can either open the repository in an isolated Docker volume:
- Press F1 and select the Dev Containers: Try a Sample... command.
- Choose the "PHP" sample, wait for the container to start, and try things out!
  
  Note: Under the hood, this will use the Dev Containers: Clone Repository in Container Volume... command to clone the source code in a Docker volume instead of the local filesystem. Volumes are the preferred mechanism for persisting container data.
Or open a locally cloned copy of the code:
- Clone this repository to your local filesystem.
- Press F1 and select the Dev Containers: Open Folder in Container... command.
- Select the cloned copy of this folder, wait for the container to start, and try things out!

Things to try

Once you have this sample opened, you'll be able to work with it like you would locally.

Some things to try:

Edit:
- Open index.php
- Try adding some code and check out the language features.
- Make a spelling mistake and notice it is detected. The Code Spell Checker extension was automatically installed because it is referenced in .devcontainer/devcontainer.json.
- Also notice that utilities like Xdebug and the PHP Intelephense extension are installed. Tools are installed in the mcr.microsoft.com/devcontainers/php image and Dev Container settings and metadata are automatically picked up from image labels.
Terminal: Press ctrl+shift+` and type uname and other Linux commands from the terminal window.
Run and Debug:
- Open index.php
- Add a breakpoint (e.g. on line 4).
- Press F5 to launch the app in the container.
- Once the breakpoint is hit, try hovering over variables, examining locals, and more.
Running a server:
- From the terminal, run php -S 0.0.0.0:8000
- Click "Open in Browser" in the notification that appears to access the web app on this new port.
  - You can view an organized table of your forwarded ports in the 'Ports' view, which can be accessed with the command Ports: Focus on Ports View.
  - Notice port 8000 in the 'Ports' view is labeled "Hello Remote World." In devcontainer.json, you can set "portsAttributes", such as a label for your forwarded ports and the action to be taken when the port is autoforwarded.
- Look back at the terminal, and you should see the output from your site navigations.
- Edit the text on line 21 in index.php and refresh the page to see the changes immediately take effect.
Attach debugger to the server:
- Follow the previous steps to start up a PHP server and open a browser on port 8000
- Press F1 and select the View: Show Debug command.
- Pick "Listen for XDebug" from the dropdown.
- Press F5 to attach the debugger.
- Add a breakpoint to index.php if you haven't already.
- Reload your browser window.
- Once the breakpoint is hit, try hovering over variables, examining locals, and more.
Install Node.js using a Dev Container Feature:
- Press F1 and select the Dev Containers: Configure Container Features... or Codespaces: Configure Container Features... command.
- Type "node" in the text box at the top.
- Check the check box next to "Node.js (via nvm) and yarn" (published by devcontainers)
- Click OK
- Press F1 and select the Dev Containers: Rebuild Container or Codespaces: Rebuild Container command so the modifications are picked up.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

License

Copyright © Microsoft Corporation All rights reserved.
Licensed under the MIT License. See LICENSE in the project root for license information.

vscode-remote-try-php's People

Contributors

Stargazers

Watchers

Forkers

fatindeed parkecag lalocespedes rabbitbeef mbamarante albertobarba moeyashi raphaelschmitz openscript thinksvip bhaskers-blu-org2 taffywrinkle claudiusgonzo qiaorong-feng pierreribault follyjohn juliencummingsross benediktvolke taqahar matsumo rachelguo76 chaoyun8888 poissons-d-or vso-dev2 codespaces-test-01 codespaces-test-02 joannawu-wd rodrmoya codespaces-test-08 arcdigital bamurtaugh global-localhost global19 global19-atlassian-net davidstrauss nixklai ramumb tangshimei qpc-database benjaminhoegh tomashaubert yanpelov technicalconsultant321 007amitgarg ebiyu taihoang123 umesh123kushwaha oscarnevarezleal rishi-3004 patthomasrick danielmabadeje abhijeet2213 killjosh saiasingle jimbobukii 9716079969fzs jeremy-faton sonkur97 gyengsam lashakilasonia jparadae heichalot steph01-00 tainastefani27 gurrarraia poudaprog mihaela2022 qora001 owsy shruti22110240 thunderna heitaodadalj rollend imjeffparedes gazimbeisaac tiago-peres matias4630 augus2007 rockclient nusrat34 futuredesignuk t92345era oing21 denzel-witbooi metallizzer pakistan420 sylvaindeloux rlikhon ibx-edu test-mass-forker-org-1 muskankhicher olguzzar dnsahoo tinawati kenlog ravikanth1980 anicolas-richard sumonst21 elimuhubconsultant-co-ke isabella232

vscode-remote-try-php's Issues

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

LAMP + phpMyAdmin

Hi, could you please provide a template that sets up an environment with Linux, MySQL, PHP, Apache and phpMyAdmin?

Asd

Development environment template doesn't stop on breakpoints

There seems to be a setup issue with this environment template.

Steps to reproduce

Open VSCode:

Version: 1.53.0 (user setup)
Commit: 8490d3dde47c57ba65ec40dd192d014fd2113496
Date: 2021-02-03T20:36:38.611Z
Electron: 11.2.1
Chrome: 87.0.4280.141
Node.js: 12.18.3
V8: 8.7.220.31-electron.0
OS: Windows_NT x64 10.0.19041

Press F1
select Remote-Containers: Try a Sample
select vscode-remote-try-php
Wait for repo pull etc.
Place breakpoint as instructed in readme (line 4 in index.php)
Press F5
Terminal output indicates script runs (lots of output), but execution is never halted on breakpoint

How to Customize PHP Extensions

I want to use the ext-swoole extension on my codespaces, but installing using pecl install swoole fails

Debugging Error Xdebug: [Step Debug] Could not connect to debugging client

Hello,

i'm using this container with the following config (devcontainer.json):

// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.0/containers/php
{
	"name": "PHP",
	"build": {
		"dockerfile": "Dockerfile",
		"args": { 
			// Update VARIANT to pick a PHP version: 8, 8.0, 7, 7.4, 7.3
			"VARIANT": "8",
			"NODE_VERSION": "lts/*"
		}
	},
	
	// Set *default* container specific settings.json values on container create.
	"settings": { 
		"php.validate.executablePath": "/usr/local/bin/php"
	},

	// Add the IDs of extensions you want installed when the container is created.
	"extensions": [
		"felixfbecker.php-debug",
		"bmewburn.vscode-intelephense-client",
		"mrmlnc.vscode-apache",
		"calebporzio.better-phpunit"
	],

	// Use 'forwardPorts' to make a list of ports inside the container available locally.
	// "forwardPorts": [8080],

	// Use 'portsAttributes' to set default properties for specific forwarded ports. More info: https://code.visualstudio.com/docs/remote/devcontainerjson-reference.
	"portsAttributes": {
		"8000": {
			"label": "Hello Remote World",
			"onAutoForward": "notify"
		}
	},

	// Use 'otherPortsAttributes' to configure any ports that aren't configured using 'portsAttributes'.
	// "otherPortsAttributes": {
	// 		"onAutoForward": "silent"
	// },

	// Use 'postCreateCommand' to run commands after the container is created.
	// "postCreateCommand": "sudo chmod a+x \"$(pwd)\" && sudo rm -rf /var/www/html && sudo ln -s \"$(pwd)\" /var/www/html"

	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
	"remoteUser": "vscode"
}

When i run any php process i receive this error

Xdebug: [Step Debug] Could not connect to debugging client. Tried: localhost:9000 (through xdebug.client_host/xdebug.client_port) :-(

Dockerfile is still as is: https://github.com/microsoft/vscode-remote-try-php/blob/67e233b925a64f90a46092879ed82b9e6d89f19e/.devcontainer/Dockerfile

Am i doing something wrong? Thanks in advance!

unable to install php8.1-zip

Hey there,
thank you for providing this repository. I've spent some time playing with it, and at the moment I am failing on attempts to install zip extension.
I was trying this from withing a container:

vscode ➜ /workspace $ sudo apt-get install php8.1-zip
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
E: Unable to locate package php8.1-zip
E: Couldn't find any package by glob 'php8.1-zip'
E: Couldn't find any package by regex 'php8.1-zip

I spent some time googling around, but it seems like I am missing something essential.
Thank you in advance for your help.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.

Jobs

Jooble