{"id":21108302,"url":"https://github.com/mxvsh/floxum","last_synced_at":"2026-03-07T09:31:21.134Z","repository":{"id":47188635,"uuid":"404223023","full_name":"mxvsh/floxum","owner":"mxvsh","description":"Floxum adds realtime support to Strapi applications","archived":false,"fork":false,"pushed_at":"2021-09-10T02:08:31.000Z","size":161,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T06:51:06.351Z","etag":null,"topics":["javascript","lerna","socket-io","strapi"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mxvsh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-08T05:32:45.000Z","updated_at":"2022-07-01T14:00:28.000Z","dependencies_parsed_at":"2022-08-28T11:00:32.663Z","dependency_job_id":null,"html_url":"https://github.com/mxvsh/floxum","commit_stats":null,"previous_names":["mxvh/floxum","mxvsh/floxum","xencodes/floxum"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/mxvsh/floxum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mxvsh%2Ffloxum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mxvsh%2Ffloxum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mxvsh%2Ffloxum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mxvsh%2Ffloxum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mxvsh","download_url":"https://codeload.github.com/mxvsh/floxum/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mxvsh%2Ffloxum/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30210829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T09:02:10.694Z","status":"ssl_error","status_checked_at":"2026-03-07T09:02:08.429Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["javascript","lerna","socket-io","strapi"],"created_at":"2024-11-20T00:45:56.718Z","updated_at":"2026-03-07T09:31:21.101Z","avatar_url":"https://github.com/mxvsh.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Floxum (WIP)\n\nFloxum is a Socket IO connector for Strapi\n\n\n![Artboard](https://user-images.githubusercontent.com/31907722/132536324-df8029d9-8f10-4041-a779-fedb872283a6.png)\n\n## Example\n\n```js\nfloxum.services('todo', 'find', { _limit: 1 }).then((data) =\u003e {\n   console.log(data)\n})\n```\n\n```\nfloxum.services('todo', 'delete', { id: 1 }).then((data) =\u003e {\n   console.log(\"Successfully deleted todo\")\n})\n```\n\n\n## Installation\n\n\n\u003e The installation will also work for existing Strapi project.\n\n\n### Step 1\n\nInstall the following module inside your React project:\n\n```bash\nyarn add @floxum/react\n```\n\n### Step 2\n\nInstall the following module inside your Strapi application:\n\n```bash\nyarn add @floxum/core\n```\n\n### Step 3\n\nCreate a new file inside your React application to setup Floxum at `src/providers` (or anywhere you'd want) named `floxum.js`, and paste the following code.\n\n```js\nimport Floxum from '@floxum/react'\n\nconst floxum = Floxum('http://localhost:1337')\n\nexport default floxum\n```\n\nChange the host string to your Strapi host.\n\n### Step 4\n\nInside your Strapi applicaiton, go to `config/functions/bootstrap.js`, and import Floxum then call it inside the export module with `strapi` parameters:\n\n```js\n\"use strict\";\nconst folxum = require(\"@floxum/core\");\n\nmodule.exports = async () =\u003e {\n  folxum(strapi);\n};\n```\n\nYou're now good to go!\n\n\n### Step 5\n\nInside your Rect project (in any component) import Floxum and and test it by calling ping function, like this:\n\n```js\nuseEffect(() =\u003e {\n  floxum.ping().then(() =\u003e {\n    console.log('working')\n  })\n}, []);\n```\n\n# Functions\n\nHere are the functions available in Floxum API\n\n## ping\nThis will test the connection with the Strapi server. Returns a Promise.\n\n## register\n\nThis function is used to register a user.\n**Example**:\n```js\nfloxum.register({ username: 'xxxxx', email: 'xxxxx', password: '****'})\n\t.then(data =\u003e {\n\t\t// data: jwt and others values\n\t})\n\t.catch(err =\u003e {\n\t\t// err: Strapi error\n\t})\n```\n\n## login\n\nThis function is used to login a user.\n**Example**:\n```js\nfloxum.login({ identifier: 'xxxxx', password: '****'})\n\t.then(data =\u003e {\n\t\t// data: jwt and others values\n\t})\n\t.catch(err =\u003e {\n\t\t// err: Strapi error\n\t})\n```\n\n## authenticate\n\nThis function can be used to get the currently logged in user's data, using token from `localStorage`\n**Example**:\n```js\nfloxum.authenticate()\n\t.then(data =\u003e {\n\t\t// data: user data and others values\n\t})\n\t.catch(err =\u003e {\n\t\t// err: Strapi error\n\t})\n```\n## services\n\nThis function can be used to execute services for any API registered on Strapi. The following example will create a new entry in \"todo\" collection.\nYou can also execute, `find`, `update` or `delete` services.\n**Example**:\n```js\nfloxum.services('todo', 'create', { todo: 'Grab coffee' })\n\t.then(data =\u003e {\n\t\t// data: response from the Strapi\n\t})\n\t.catch(err =\u003e {\n\t\t// err: Strapi error\n\t})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmxvsh%2Ffloxum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmxvsh%2Ffloxum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmxvsh%2Ffloxum/lists"}