{"id":13765978,"url":"https://github.com/CanopyTax/sofe","last_synced_at":"2025-05-10T21:32:39.123Z","repository":{"id":3121822,"uuid":"47775257","full_name":"CanopyTax/sofe","owner":"CanopyTax","description":"Service Oriented Front-end","archived":false,"fork":false,"pushed_at":"2022-03-02T02:08:57.000Z","size":450,"stargazers_count":139,"open_issues_count":5,"forks_count":9,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-04-14T22:14:12.776Z","etag":null,"topics":["front-end"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CanopyTax.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":"2015-12-10T16:54:40.000Z","updated_at":"2023-08-08T08:38:50.000Z","dependencies_parsed_at":"2022-08-06T13:15:43.148Z","dependency_job_id":null,"html_url":"https://github.com/CanopyTax/sofe","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CanopyTax%2Fsofe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CanopyTax%2Fsofe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CanopyTax%2Fsofe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CanopyTax%2Fsofe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CanopyTax","download_url":"https://codeload.github.com/CanopyTax/sofe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224989938,"owners_count":17403410,"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":["front-end"],"created_at":"2024-08-03T16:00:49.885Z","updated_at":"2024-11-17T01:31:48.206Z","avatar_url":"https://github.com/CanopyTax.png","language":"JavaScript","funding_links":[],"categories":["Tools","Uncategorized","Tooling"],"sub_categories":["Related","Uncategorized"],"readme":"# Project status\n\n**Sofe is a plugin for systemjs@0.21, but the latest version of systemjs is \u003e3. The\n[new versions of systemjs](https://github.com/systemjs/systemjs) have the equivalent of sofe\nbuilt into systemjs itself, via [import maps](https://github.com/WICG/import-maps).\nBecause of this, we encourage that you use systemjs@\u003e=3 + import maps, instead of using\nsystemjs@0.21 + sofe. See\n[this file](https://gitlab.com/TheMcMurder/single-spa-portal-example/blob/master/src/index.html#L10) for\nan example of what the new alternative looks like. For the equivalent of sofe's local storage overrides, check\nout [import-map-overrides](https://github.com/joeldenning/import-map-overrides/).**\n\n# sofe\nService Oriented Front-end - Sofe is a [SystemJS](https://github.com/systemjs/systemjs) plugin that resolves a module name to a fully qualified url at runtime.\n\n[![npm version](https://img.shields.io/npm/v/sofe.svg?style=flat-square)](https://www.npmjs.org/package/sofe)\n[![Build Status](https://img.shields.io/travis/CanopyTax/sofe.svg?style=flat-square)](https://travis-ci.org/CanopyTax/sofe)\n[![Code Coverage](https://img.shields.io/codecov/c/github/CanopyTax/sofe.svg?style=flat-square)](https://codecov.io/github/CanopyTax/sofe)\n\nSofe allows developers to avoid building monolothic front-end web applications and instead build software on top of micro-services. Sofe is a JavaScript library that enables independently deployable JavaScript services to be retrieved at run-time in the browser.\n\nMore on the [motivation for SOA in the browser](docs/motivation.md)\n\n### Getting Started\n1. [Setup SystemJS and JSPM](http://jspm.io/docs/getting-started.html)\n2. Configure SystemJS to use the sofe plugin:\n\n  ```bash\n  jspm install npm:sofe\n  ```\n3. Load sofe services:\n\n  ```javascript\n  System.import('sofe-hello-world!sofe')\n    .then(hello =\u003e hello())\n  // Sofe is properly setup if the browser alerts a hello world.\n  // You have successfully loaded the hello-world sofe service.\n  ```\n  By default, any npm package with a UMD build can be a sofe service. Simply load the service by the package name:\n\n  ```javascript\n  System.import('backbone!sofe')\n    .then(Backbone =\u003e new Backbone.View({}));\n  ```\n\n### Create your own service\nBy default, all npm packages are loaded through npm ([unpkg](https://unpkg.com)). While this is convenient, it isn't always\nwhat you want to do for your own services. You can provide a custom location for where your service distributable is located\nby adding a `sofe` property to your package.json:\n```javascript\n{\n  \"name\": \"my-service\",\n  \"version\": \"1.0.0\",\n  \"sofe\": {\n    \"url\": \"https://cdn.some-location.com/my-service-1.0.0.js\"\n  }\n}\n```\nRepublish a new sofe URL to npm whenever you want to update the location of your service distributable.\n\n### Services in production\nCreate your own private service by telling sofe how to resolve your service name. Add to your systemjs configuration a manifest\noption to a sofe property or auto-discover services by loading a remote manifest of available services:\n```javascript\nSystem.config({\n  sofe: {\n    manifest: {\n      \"someInternalService\": \"http://somelocation.com/service-1.0.0.js\"\n    },\n    manifestUrl: 'https://somelocation.com/available-services.json'\n  }\n});\n```\n\nLearn more about production configuration within the [API documentation](docs/sofe-api.md)\n\n### Examples\nExamples are available at [sofe.surge.sh](http://sofe.surge.sh) or you can run them [locally](examples/examples.md)\n\n### Tools\n1. [sofe-inspector](https://github.com/CanopyTax/sofe-inspector) - Developer tool for inspecting and overriding available sofe services\n1. [sofe-babel-plugin](https://github.com/CanopyTax/sofe-babel-plugin) - A babel plugin for production sofe workflows with webpack\n1. [sofe-deplanifester](https://github.com/CanopyTax/sofe-deplanifester) - A manifest deployment service for sofe\n1. [sofe-hello-world](https://github.com/CanopyTax/sofe-hello-world) - A simple sofe-service to say hello\n\n### License\nCopyright 2016 CanopyTax\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCanopyTax%2Fsofe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCanopyTax%2Fsofe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCanopyTax%2Fsofe/lists"}