CONTRIBUTING.md 870 Bytes
Newer Older
1 2 3 4 5
# For Contributors
Contribution is welcome. You should be a seasoned web developer and feel comfortable around git, gulp, modular javascript without jQuery(!), ITCSS, BEM and CSS Namespaces.

## Build Requirements
You need Node and Npm available on your system. And you also need the REST Server that handles the server side functions
Dirk Benkert committed
6
of the project. This is another Repository contact @dbenkert to get access to the REST Server repository.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

Run
```
npm install
npm install jscpd -g
```
to install the dependencies. For a list of packages required see package.json. The build relies on Gulp
as task runner and uses less, require.js and jade.

Run
```
gulp
```
to build the website.

Modify gulpfile.js to built into an alternate directory.
```
var targetDirectory = "your path"
```

Modify `"your path"/resources/js/config/local.js`. Add the URL to the REST Server here.