{"id":16401077,"url":"https://github.com/flodlc/nebula","last_synced_at":"2025-03-16T16:31:48.549Z","repository":{"id":57112802,"uuid":"452756280","full_name":"flodlc/nebula","owner":"flodlc","description":"Nebula is a lightweight JavaScript library for creating beautiful universe and sky animations. Including configurable Stars, Nebulas, Comets, Planets and Suns. Compatible with SSR","archived":false,"fork":false,"pushed_at":"2022-09-25T17:22:57.000Z","size":1185,"stargazers_count":56,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-27T11:42:12.088Z","etag":null,"topics":["canvas","js","nebula","planets","reactjs","stars","vanilla-js"],"latest_commit_sha":null,"homepage":"https://nebula-demo.vercel.app/","language":"TypeScript","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/flodlc.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":"2022-01-27T16:23:21.000Z","updated_at":"2024-11-20T05:21:24.000Z","dependencies_parsed_at":"2022-08-21T13:00:41.102Z","dependency_job_id":null,"html_url":"https://github.com/flodlc/nebula","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flodlc%2Fnebula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flodlc%2Fnebula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flodlc%2Fnebula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flodlc%2Fnebula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flodlc","download_url":"https://codeload.github.com/flodlc/nebula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243822295,"owners_count":20353500,"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":["canvas","js","nebula","planets","reactjs","stars","vanilla-js"],"created_at":"2024-10-11T05:29:21.823Z","updated_at":"2025-03-16T16:31:48.197Z","avatar_url":"https://github.com/flodlc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Nebula\n### Nebula is a lightweight (1kb compressed) JavaScript library that creates beautiful universe and sky animations.\nIncluding configurable Stars, Nebulas, Comets, Planets and Suns.  \nNebula comes with a vanilla JS and a React wrapper.  \nCompatible with SSR\n\n\u003ca href=\"https://nebula-demo.vercel.app/\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/flodlc/nebula/master/demo_image.jpg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://nebula-demo.vercel.app/\"\u003eDemo page\u003c/a\u003e\n\n### `Installation`\n```\nnpm install @flodlc/nebula\n```\n\n### `usage`\n#### `Vanilla JS`\n```javascript\nimport { createNebula } from \"@flodlc/nebula\";\n\n\u003cdiv id=\"nebula-element\"\u003e\u003c/div\u003e\n\nconst element = document.getElementById(\"nebula-element\");\n\nconst nebula = createNebula(element, {\n    starsCount: 250,\n    starsRotationSpeed: 3,\n    nebulasIntensity: 8,\n    ...\n});\n// ... if needed:\nnebula.destroy()\n ```\n\n#### `React`\n ```javascript\nimport { ReactNebula } from \"@flodlc/nebula\";\n\nexport default App = () =\u003e {\n    return (\n        \u003c\u003e\n            // With default config\n            \u003cReactNebula/\u003e\n\n            // With custom config\n            \u003cReactNebula config={{\n                starsCount: 250,\n                starsRotationSpeed: 3,\n                nebulasIntensity: 8,\n                ...\n            }}/\u003e\n        \u003c/\u003e\n    );\n}\n ```\nThe canvas is positioned ``absolute`` and takes the size of its parent.\n### `Config`\nkey | option type | default | Comment\n---|-----------|---|---\n`starsCount` | `number` | `350` | Recommended: \u003c `1000`\n`starsColor` | `string` | `#ffffff`\n`starsRotationSpeed` | `number` | `3`\n`cometFrequence` | `number` | `15` | `0` disables the comets\n`nebulasIntensity` | `number` | `10`\n`sunScale` | `number` | `1` | `0` hides the Sun\n`planetsScale` | `number` | `1` | `0` hides the planets\n`solarSystemOrbite` | `number` | `65` |  Recommended: \u003c `100`\n`solarSystemSpeedOrbit` | `number` | `100`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflodlc%2Fnebula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflodlc%2Fnebula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflodlc%2Fnebula/lists"}