{"id":13544591,"url":"https://github.com/milroyfraser/sarala","last_synced_at":"2026-01-18T02:16:30.090Z","repository":{"id":143907489,"uuid":"120319696","full_name":"milroyfraser/sarala","owner":"milroyfraser","description":"Javascript library to communicate with RESTful API built following JSON API specification. inspired by Laravel’s Eloquent","archived":false,"fork":false,"pushed_at":"2019-10-17T09:41:31.000Z","size":455,"stargazers_count":111,"open_issues_count":9,"forks_count":8,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-04T13:36:43.264Z","etag":null,"topics":["eloquent","javascript","json-api","laravel","orm","restful-api"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/milroyfraser.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-02-05T15:01:09.000Z","updated_at":"2024-09-18T06:32:34.000Z","dependencies_parsed_at":"2023-07-26T06:46:22.971Z","dependency_job_id":null,"html_url":"https://github.com/milroyfraser/sarala","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milroyfraser%2Fsarala","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milroyfraser%2Fsarala/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milroyfraser%2Fsarala/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milroyfraser%2Fsarala/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/milroyfraser","download_url":"https://codeload.github.com/milroyfraser/sarala/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246832323,"owners_count":20841153,"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":["eloquent","javascript","json-api","laravel","orm","restful-api"],"created_at":"2024-08-01T11:00:51.245Z","updated_at":"2026-01-18T02:16:30.084Z","avatar_url":"https://github.com/milroyfraser.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cp align=\"center\"\u003e\u003cimg src=\"https://milroy.me/img/sarala-logo.svg\" width=\"200\"\u003e\u003c/p\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/milroyfraser/sarala/blob/master/LICENSE\"\u003e\n      \u003cimg src=\"https://img.shields.io/apm/l/vim-mode.svg\" /\u003e\n    \u003c/a\u003e  \n    \u003ca href=\"https://travis-ci.org/milroyfraser/sarala\"\u003e\n      \u003cimg src=\"https://travis-ci.org/milroyfraser/sarala.svg?branch=master\" /\u003e\n    \u003c/a\u003e\n    \u003ca href='https://coveralls.io/github/milroyfraser/sarala'\u003e\n        \u003cimg src='https://coveralls.io/repos/github/milroyfraser/sarala/badge.svg' alt='Coverage Status' /\u003e\n    \u003c/a\u003e   \n\u003c/p\u003e\n\n# Sarala JS\n\n\u003e Javascript library to communicate with RESTful API built following JSON API specification. inspired by Laravel’s Eloquent\n\n### [API Documentation](https://sarala-io.github.io/sarala-js-docs/guide/) | [Background Story](https://milroy.me/posts/sarala-laravel-eloquent-like-javascript-orm-to-communicate-with-json-api/1)\n\n## Install\n\n```sh\n$ npm i sarala --save\n```\n\n```sh\n$ yarn add sarala\n```\n\n# Basic Usage\n\n## Model Implementation\n\n##### app/models/BaseModel.js\n```javascript\nimport { Model } from 'sarala';\nimport axios from 'axios';\n\nexport default class BaseModel extends Model\n{\n    baseUrl () {\n        return 'https://sarala-demo.app/api';\n    }\n\n    request (config) {\n        return axios.request(config);\n    }\n}\n```\n\n##### app/models/Post.js\n```javascript\nimport Model from './BaseModel';\nimport Tag from './Tag';\n\nexport default class Post extends Model {\n    resourceName () {\n        return 'posts';\n    }\n\n    fields () {\n        return ['title', 'subtitle', 'body', 'slug'];\n    }\n\n    relationships () {\n        return {\n            tags: new Tag()\n        };\n    }\n}\n```\n\n##### app/models/Tag.js\n```javascript\nimport Model from './BaseModel';\n\nexport default class Tag extends Model {\n    resourceName () {\n        return 'tags';\n    }\n\n    fields () {\n        return ['name'];\n    }\n}\n```\n\n## Fetching data\n\n```javascript\nimport Post from './../models/Post';\n\nconst post = new Post();\n\n// makes a GET request to https://sarala-demo.app/api/posts\nconst fetchAllPosts = async () =\u003e {\n    let posts = await post.with(['tags']).all();\n};\n```\n\n## Insert\n\n##### app/components/MyComponent.js\n```javascript\nimport Tag from './../models/Tag';\n\nconst tag = new Tag();\ntag.name = 'json-api';\n\n// makes a POST request to https://sarala-demo.app/api/tags\ntag.save(); \n// or you can directly call tag.create();\n```\n\n## Change log\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n### [API Documentation](https://sarala-io.github.io/sarala-js-docs/guide/) | [Background Story](https://milroy.me/posts/sarala-laravel-eloquent-like-javascript-orm-to-communicate-with-json-api/1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmilroyfraser%2Fsarala","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmilroyfraser%2Fsarala","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmilroyfraser%2Fsarala/lists"}