How to contribute

Test it locally

Using Docker

Clone the repository
Ensure your Docker daemon is running
Copy docker/php/env.example to docker/php/env and customize
Launch docker-compose run --rm php composer install to bootstrap php dependencies
Launch docker-compose run --rm php bin/console wallabag:install to bootstrap your installation
Launch docker-compose run --rm php yarn install to bootstrap dependencies for the frontend
Launch docker-compose run --rm php yarn build:dev to build assets for the frontend
Launch docker-compose up -d to start the stack

You'll then have:

a PHP daemon with standalone web server
a Redis database (to handle imports)
a SQLite database to store articles

You can now access your wallabag instance using that url: http://127.0.0.1:8000

If you want to test using an other database than SQLite, uncomment the postgres or mariadb code from the docker-compose.yml file at the root of the repo. Also uncomment related line in the php section so the database will be linked to your PHP instance.

Using your own PHP server

Ensure you are running PHP >= 7.4.
Clone the repository
Launch composer install
If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
Then php bin/console wallabag:install
If you got some errors, fix them (they might be related to some missing PHP extension from your machine)
Run php bin/console server:run

You can now access your wallabag instance using that url: http://127.0.0.1:8000

You found a bug

Please open a new issue.

To fix the bug quickly, we need some infos: please answer to the questions in the issue form.

If you have the skills, look for errors into PHP, server and application logs (see var/logs).

Note : If you have large portions of text, use Github's Gist service or other pastebin-like.

You want to fix a bug or to add a feature

Please fork wallabag and work with the master branch.

Run Tests and PHP formatter

All pull requests need to pass the tests and the code needs match the style guide.

To run the tests locally run:

when testing using Docker: docker-compose run --rm php bin/phpunit (or docker-compose run --rm php make test if you prefer using make)
otherwise: bin/phpunit (or make test)

To run the PHP formatter:

when testing using Docker: docker-compose run --rm php bin/php-cs-fixer fix
otherwise: php bin/php-cs-fixer fix

2.5 KiB Raw Permalink Blame History