Skip to content
This repository was archived by the owner on Nov 25, 2020. It is now read-only.

Commit e3ace4b

Browse files
authored
Update CONTRIBUTING.md
1 parent 2d43128 commit e3ace4b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,29 @@ PLEASE READ THE FOLLOWING BEFORE POSTING A BUG.
1919
**POST A GITHUB ISSUE / SUBMIT PR**
2020
> Make sure to put as many details as possible. If you are referring to a discussion on the Forum, add the link. The more info you give, the more easily we can reproduce the bug, the quicker we can fix it.
2121
> If you are submitting a Pull Request, please sign the [Contributor License Agreement](https://pydio.com/en/community/contribute/contributor-license-agreement-cla).
22+
23+
24+
#### Setting up your dev environment
25+
26+
Pydio 7 requires **PHP5.6** and upper.
27+
28+
The web root of the application is located in ***core/src/***. Create a virtual host to point to this folder, set up your webserver to use index.php as default page. This is generally done by default.
29+
30+
Pydio uses Composer and NPM to manage dependencies respectively in PHP and JS. It uses Grunt to build javascript sources. In order to start Pydio locally after a fresh `git clone`, you will first have to run these tools in both the core and in many plugins.
31+
32+
- First install Composer (see https://getcomposer.org) and NPM (https://docs.npmjs.com/getting-started/installing-node)
33+
- Install Grunt globally by running `npm install -g grunt-cli``
34+
- Inside the core folder (under webroot, i.e. core/src/core/ from root of git repository), run `composer install`
35+
- For each plugin that contains a composer.json file, run `composer install` as well.
36+
- For each plugin tat contains a package.json file, run
37+
- `npm install`
38+
- `grunt`
39+
40+
On a unix-based machine, this can be achieved by the following command (from the webroot directory):
41+
```
42+
find . -maxdepth 5 -name Gruntfile.js -execdir bash -c "npm install && grunt" \;
43+
find . -maxdepth 5 -name composer.json -execdir composer install \;
44+
```
45+
46+
You should be good to go. When modifying JS files that require transpilation, there is generally a `grunt watch` task available to automatically run grunt on each file change.
47+

0 commit comments

Comments
 (0)