{"id":24529282,"url":"https://github.com/opencomponents/get-started","last_synced_at":"2025-08-20T00:04:53.566Z","repository":{"id":55057053,"uuid":"99382034","full_name":"opencomponents/get-started","owner":"opencomponents","description":"🔰 ⚡️ 👟  Get started with OpenComponents in 3 simple steps","archived":false,"fork":false,"pushed_at":"2023-11-28T10:04:20.000Z","size":36,"stargazers_count":48,"open_issues_count":0,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-14T17:11:27.107Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/opencomponents.png","metadata":{"files":{"readme":"README-NOW.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-04T21:50:26.000Z","updated_at":"2025-03-14T21:26:24.000Z","dependencies_parsed_at":"2025-01-22T07:45:59.124Z","dependency_job_id":null,"html_url":"https://github.com/opencomponents/get-started","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/opencomponents/get-started","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencomponents%2Fget-started","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencomponents%2Fget-started/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencomponents%2Fget-started/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencomponents%2Fget-started/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencomponents","download_url":"https://codeload.github.com/opencomponents/get-started/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencomponents%2Fget-started/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271242036,"owners_count":24724978,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-22T07:35:44.374Z","updated_at":"2025-08-20T00:04:53.485Z","avatar_url":"https://github.com/opencomponents.png","language":"JavaScript","readme":"# Starter Kit\n\nGet up and running with OpenComponents in 3 simple steps.\n\nBefore starting make sure you have:\n- An account on [Now](https://zeit.co/now) and its [CLI installed](https://zeit.co/download#command-line)\n- An [S3](https://aws.amazon.com/s3) bucket on AWS\n\n## #1 - Deploy the OpenComponents Registry to Now\n\nClone this repository locally:\n\n```\n$ git clone https://github.com/opencomponents/starter-kit \u0026\u0026 cd starter-kit\n```\n\nAdd the needed secrets environment variables with the now CLI:\n\n- `s3-key`\n- `s3-secret`\n- `s3-region`\n- `s3-bucket`\n- `publish-username`\n- `publish-password`\n\n```\n$ now secret s3-key yourvaluehere\n...\n```\n\nand make them available as environment variables:\n\n```\n$ now -e S3_KEY=@s3-key -e S3_SECRET=@s3-secret -e S3_REGION=@s3-region -e S3_BUCKET=@s3-bucket -e PUBLISH_USERNAME=@publish-username -e PUBLISH_PASSWORD=@publish-password\n```\n\nFor further help with the now CLI, please refere to their [docs](https://zeit.co/docs/features/now-cli)\n\nYou are now ready to deploy, simply type:\n\n```\n$ now\n```\n\nIf prompted, choose the Dockerfile deploy\n\n\n## #2 - Build your first component\n\nInstall the OpenComponents CLI\n\n```\n$ npm install -g oc\n```\n\nCreate your first component:\n\n```\n$ oc init my-first-component\n```\n\nDevelop/Test locally by starting a local dev registry\n\n```\n$ oc dev . 3030\n```\n\nYour component will be available at: \n\n- endpoint: [http://localhost:3030/my-first-component](http://localhost:3030/my-first-component)\n\n- info: [http://localhost:3030/my-first-component/~info](http://localhost:3030/my-first-component/~info)\n\n- fullPreview: [http://localhost:3030/my-first-component/~preview](http://localhost:3030/my-first-component/~preview)\n\n## #3 Publish the component to the registry\n\nAdd the registry to the CLI:\n\n```\n$ oc registry add http://my-registryurl.on.now.sh/\n```\n\nPublish your component\n\n```\n$ oc publish my-first-component --username=YOURVALUEHERE --password=YOURVALUEHERE\n```\n\nYour component is now published 🎉 🎉 🎉 !\n\nYou can consume it here: `http://my-registryurl.on.now.sh/my-first-component`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencomponents%2Fget-started","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencomponents%2Fget-started","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencomponents%2Fget-started/lists"}