| Server IP : 5.161.254.237 / Your IP : 216.73.216.252 Web Server : Apache System : Linux diamond.sialwebvps.com 4.18.0-553.8.1.el8_10.x86_64 #1 SMP Tue Jul 2 07:26:33 EDT 2024 x86_64 User : stellasp ( 1131) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/stellasp/public_html/backend/vendors/jszip/documentation/ |
Upload File : |
--- title: Contributing layout: default section: main --- ### Download the sources You should create a [Github](https://github.com/) account and [fork the repository](https://help.github.com/articles/fork-a-repo) (you will need one to create the pull request). If you just want the get the source code, you can use git and do `git clone https://github.com/Stuk/jszip.git` to get the sources. You can also download the latest sources [here](https://github.com/Stuk/jszip/archive/master.zip). ### Building the project #### Code The dependencies are handled by npm, the first step is to run `npm install` to get the dependencies. JSZip uses Grunt to handle the build, [see here to install its CLI](http://gruntjs.com/getting-started). Here are the interesting build commands : * `grunt` will generate the final js file in dist/ and the minified version. * `npm run test-node` will run the tests in nodejs. * `npm run test-browser` will the tests in some browsers using SauceLabs, see below. * `npm run test` will run the tests in nodejs and in the browser. * `npm run lint` will use jshint the check the source code. #### Documentation The documentation uses jekyll on gh-pages. To render the documentation, you need to [install jekyll](http://jekyllrb.com/docs/installation/) and then run `jekyll serve --baseurl ''`. ### Testing the project To test JSZip in nodejs, use `npm run test-node`. To test JSZip in a browser, you can open the file `test/index.html` in the browser you want to test. Don't forget to update the dist/ files with `grunt`. You can also test JSZip in a lot of browsers at once with [SauceLabs](https://saucelabs.com/). You will need a SauceLabs account and two variables into your environment. On linux, just use ```bash export SAUCE_USERNAME=your-saucelabs-username export SAUCE_ACCESS_KEY=your-saucelabs-access-key ``` before running the `npm run test-browser` command. ### Merging the changes If you have tested bug fixes or new features, you can open a [pull request](https://help.github.com/articles/using-pull-requests) on Github.