Php revival

Browser extension every PHP developer must have. It changes styles on php.net website for a better experience of using php documentation.

PHP Revival

Browser extension that every PHP developer must have. It changes styles on the php.net website for a better experience of using php documentation. Extension adds dark and light themes, changes color scheme of code samples and makes User Contributed Notes more readable.

Links

Contribute

Download the Project

Clone the Repo

With HTTP:

git clone https://codeberg.org/php-revival/php-revival.git && cd php-revival

With SSH:

git clone ssh://git@codeberg.org/php-revival/php-revival.git && cd php-revival

NPM Commands Available

All necessary scripts are in package.json file. I'm using the wrapper around a webpack that's called Laravel mix.

Install all Dependencies

npm i

Watch File Changes

Watches the changes and compiles SASS and TypeScript to CSS and JavaScript.

npm run watch

Compile to Production

Compile files for production.

npm run prod

Run Jest Tests

npm test

Configuration file for Laravel mix is called webpack.mix.js, it is in the root of the project.

With a Podman/Docker

Build the Image

To build the image, run this command. With Podman:

podman-compose build

With Docker:

docker compose build

Create node_modules

Run this command to install npm packages and generate a node_modules directory on your local machine.

With Podman:

podman-compose run --rm app npm i

With Docker:

docker compose run --rm app npm i

Run the Container

Start the container which will watch your changes and compile them to plain JavaScript and CSS.

With Podman:

podman-compose up

With Docker:

docker compose up

You can add -d (detached) mode to make it run in background, but I suggest not using detached mode since you're not going to see any Weback errors.

Enter the Container

Enter inside the container. With Podman:

podman-compose exec app bash

With Docker:

docker compose exec app bash

You'll be able to run NPM commands inside of the container.

[!NOTE] You don't need to run npm run watch inside since this command is already running from the start of container.

Destroy the Container

Remove the container with Podman:

podman-compose down

With Docker:

docker compose down