{"id":19693553,"url":"https://github.com/ezsystems/ez-js-rest-client","last_synced_at":"2025-04-29T09:31:50.804Z","repository":{"id":9389116,"uuid":"11250796","full_name":"ezsystems/ez-js-rest-client","owner":"ezsystems","description":"Javascript REST client for eZ Platform RESTv2 API, mimics PHP API found in eZ Platform.","archived":false,"fork":false,"pushed_at":"2018-12-18T15:38:21.000Z","size":4890,"stargazers_count":6,"open_issues_count":7,"forks_count":10,"subscribers_count":27,"default_branch":"master","last_synced_at":"2025-04-15T11:44:30.139Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ezsystems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-08T09:36:06.000Z","updated_at":"2019-04-06T07:48:22.000Z","dependencies_parsed_at":"2022-08-29T17:30:44.655Z","dependency_job_id":null,"html_url":"https://github.com/ezsystems/ez-js-rest-client","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fez-js-rest-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fez-js-rest-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fez-js-rest-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ezsystems%2Fez-js-rest-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ezsystems","download_url":"https://codeload.github.com/ezsystems/ez-js-rest-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251473495,"owners_count":21595057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T19:17:12.713Z","updated_at":"2025-04-29T09:31:50.483Z","avatar_url":"https://github.com/ezsystems.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JavaScript client for the eZ Platform REST API\n\n[![Build Status](https://travis-ci.org/ezsystems/ez-js-rest-client.png)](https://travis-ci.org/ezsystems/ez-js-rest-client)\n\nThis repository provides a JavaScript library meant to ease the usage of [the eZ\nPublish REST API](https://doc.ez.no/display/TECHDOC/REST+API+Tutorials).\n\n## Installation\n\nThe eZ Platform JavaScript REST Client is a [bower](http://bower.io) package, so\nthe easiest way to install it is to run:\n\n```\n$ bower install --save ezsystems/ez-js-rest-client\n```\n\nThen you can include in your project the file\n`bower\\_components/ez-js-rest-client/dist/CAPI-min.js` (or the non minified\nversion). It's also possible to directly take `dist/CAPI.js` or\n`dist/CAPI-min.js` in a clone of this repository.\n\n## Usage\n\nThe usage the JavaScript REST Client is detailed in [Using the JavaScript REST\nAPI\nClient](https://doc.ez.no/display/TECHDOC/Using+the+JavaScript+REST+API+Client)\n\n## Development\n\n### Requirements\n\nThe project maintenance is handled in a [nodejs](http://nodejs.org) based\nenvironment with a help of Grunt task runner.\n\n* Install [nodejs](http://nodejs.org/)\n* Clone this repository\n* From the root of the repository, install the local npm dependencies:\n  ```\n  $ npm install\n  ```\n* Install the global dependencies (usually you need to be root)\n  ```\n  # npm install -g grunt-cli yuidocjs\n  ```\n\n### API Documentation\n\nThe JavaScript API documentation can be generated in the `api` directory with:\n\n```\n$ grunt doc\n```\nAlternatively, you can run\n```\n$ grunt livedoc\n```\nto run the [yuidoc documentation\nserver](http://yui.github.io/yuidoc/args/index.html#server). The dynamic\ndocumentation can then be reached at http://127.0.0.1:3000.\n\n\n### Build\n\nThe library can be built with:\n\n```\n$ grunt build\n```\n\nThis command will (re)generate the files `dist/CAPI.js` and `dist/CAPI-min.js`.\n\n### Tests\n\n#### Unit tests\n\nThe unit tests can be executed with:\n```\n$ grunt test\n```\n\nIt's also possible to generate a coverage report with:\n\n```\n$ grunt coverage\n```\n\nAfter this command, the report is available in\n`test/coverage/lcov-report/index.html`.\n\n#### Continuous execution\n\nDuring development it may be quite handy to automatically rerun unit-tests and/or\nlint checks, once any project related file has changed.\n\nUsing so called `watch` tasks this can easily be achieved. Currently the following\nof those tasks exist:\n\n- `watch:lint`: On each file change execute a linting run\n- `watch:test`: Execute a unit-test run on each file change\n\n#### Manual tests\n\nThe library can be manually tested by installing the Symfony2 bundle\n*jsRestClientBundle*, which is situated in the test/manual/ folder.\n\nBefore bundle installation run `grunt build` command once. It will build all the\nsource files into Resources/public/js/CAPI.js file.\n\nThen the bundle could be installed into your current ezPublish 5.x instance\nusing following instruction:\n\n* Create `path/to/ezpublish5/src/EzSystems` if it does not exist.\n* Symlink the bundle into /src/EzSystems/ (keep folder name).\n* Edit /app/AppKernel.php and add the following line before in the\n  return statement of the method registerBundles:\n\n    ```php\n    $bundles[] = new EzSystems\\jsRestClientBundle\\jsRestClientBundle();\n    ```\n\n* Import routing.yml file of the bundle into main routing file by adding the\n  following lines at the very bottom of `ezpublish/config/routing.yml`:\n\n    ```yaml\n    jsRestClientBundle:\n        resource: \"@jsRestClientBundle/Resources/config/routing.yml\"\n    ```\n\n* Clear the Symfony 2 caches with app/console.\n\nAfter these steps you may access `/js-rest-client-test/` path where you will find\ntesting html page.  Most of requests can be configured a little bit before\nexecuting them by changing input values.  See details of tests implementation in\nResources/public/js/cookbook-*.js files.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fezsystems%2Fez-js-rest-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fezsystems%2Fez-js-rest-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fezsystems%2Fez-js-rest-client/lists"}