devol
/
wallabag
mirror of https://github.com/wallabag/wallabag.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
wallabag/.github/CONTRIBUTING.md

48 lines
2.0 KiB
Markdown
Raw Normal View History

Better Grammar
2014-05-17 20:32:38 +02:00
# How to contribute
contributing file
2013-08-15 11:03:36 +02:00
Improve CONTRIBUTING guide Also: - update the docker-compose to use Alpine image (lighter) - update the PHP Dockerfile to use Imagick instead of GD (for GIF support when downloading images) and add support for SQLite
2019-06-19 14:54:38 +02:00
## Test it locally
### Using Docker
- Clone the repository
- Ensure your Docker daemon is running
Update docker-compose and Dockerfile for dev env This change should ease the spawn of a development environment. It can be used as a vscode devcontainer. Signed-off-by: Kevin Decherf <kevin@kdecherf.com>
2022-03-12 19:37:47 +01:00
- 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
Improve CONTRIBUTING guide Also: - update the docker-compose to use Alpine image (lighter) - update the PHP Dockerfile to use Imagick instead of GD (for GIF support when downloading images) and add support for SQLite
2019-06-19 14:54:38 +02:00
You'll then have:
Update docker-compose and Dockerfile for dev env This change should ease the spawn of a development environment. It can be used as a vscode devcontainer. Signed-off-by: Kevin Decherf <kevin@kdecherf.com>
2022-03-12 19:37:47 +01:00
- a PHP daemon with standalone web server
Improve CONTRIBUTING guide Also: - update the docker-compose to use Alpine image (lighter) - update the PHP Dockerfile to use Imagick instead of GD (for GIF support when downloading images) and add support for SQLite
2019-06-19 14:54:38 +02:00
- 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.1.
- 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`
contributing.md updated
2013-08-25 08:32:58 +02:00
## You found a bug
change static files
2014-02-12 21:46:49 +01:00
Please [open a new issue](https://github.com/wallabag/wallabag/issues/new).
contributing.md updated
2013-08-25 08:32:58 +02:00
Update CONTRIBUTING file Fix #2059
2016-05-18 14:33:06 +02:00
To fix the bug quickly, we need some infos: please answer to the questions in the issue form.
Added advices to submit a bug Discussion at #662.
2014-05-11 15:33:44 +02:00
Improve CONTRIBUTING guide Also: - update the docker-compose to use Alpine image (lighter) - update the PHP Dockerfile to use Imagick instead of GD (for GIF support when downloading images) and add support for SQLite
2019-06-19 14:54:38 +02:00
If you have the skills, look for errors into PHP, server and application logs (see `var/logs`).
Added advices to submit a bug Discussion at #662.
2014-05-11 15:33:44 +02:00
Note : If you have large portions of text, use [Github's Gist service](https://gist.github.com/) or other pastebin-like.
contributing.md updated
2013-08-25 08:32:58 +02:00
## You want to fix a bug or to add a feature
Update CONTRIBUTING file Fix #2059
2016-05-18 14:33:06 +02:00
Please fork wallabag and work with **the master branch**.