{"id":15110287,"url":"https://github.com/andrewlipscomb/cockpit-typescript-react-boilerplate","last_synced_at":"2026-01-19T21:34:04.550Z","repository":{"id":177745514,"uuid":"113634393","full_name":"AndrewLipscomb/cockpit-typescript-react-boilerplate","owner":"AndrewLipscomb","description":"A relatively simple boilerplate for Cockpit, React and Typescript","archived":false,"fork":false,"pushed_at":"2017-12-11T08:31:03.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T16:48:17.257Z","etag":null,"topics":["boilerplate","cockpit","react","typescript2"],"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/AndrewLipscomb.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,"governance":null}},"created_at":"2017-12-09T02:09:12.000Z","updated_at":"2023-06-17T17:05:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"0fb3837d-f995-44a9-8970-4e6afe336ed5","html_url":"https://github.com/AndrewLipscomb/cockpit-typescript-react-boilerplate","commit_stats":null,"previous_names":["altinners/cockpit-typescript-react-boilerplate","andrewlipscomb/cockpit-typescript-react-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewLipscomb%2Fcockpit-typescript-react-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewLipscomb%2Fcockpit-typescript-react-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewLipscomb%2Fcockpit-typescript-react-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewLipscomb%2Fcockpit-typescript-react-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndrewLipscomb","download_url":"https://codeload.github.com/AndrewLipscomb/cockpit-typescript-react-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369937,"owners_count":20927927,"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":["boilerplate","cockpit","react","typescript2"],"created_at":"2024-09-25T23:43:54.456Z","updated_at":"2026-01-19T21:34:04.523Z","avatar_url":"https://github.com/AndrewLipscomb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cockpit Boilerplate Component using Typescript/React/Webpack\n\nA straightforward CockpitJS component written to simplify new module creation. \n\n## Before You Start\n\nMake sure you have the correct version of Node installed. You need 8.X.X or above.\n\n```\nnode --version\n```\n\nIf you don't have it installed, or you have an old version, update [here](https://nodejs.org/en/download/).\n\n## Installation\n\nAs this is intended to be used as a boilerplate, it is suggested that you clone the repo into a folder with the name of your intended module. \n\n```\ngit clone https://github.com/ALTinners/cockpit-typescript-react-boilerplate.git MyModuleName\ncd MyModuleName\nnpm install\n```\n\nIf any of these fail, you need to put [Node](https://nodejs.org/en/download/) on your target machine. Currently I've tested this with the latest LTS, but JS is a fast changing environment - you will need regular updates to keep it up to date with the latest Node environs. \n\nYou can then build the application from source \n```\nnpm run build-test\n```\n\nWhich will build the JS package. To link this to Cockpit, run\n\n```\nnpm run link-to-cockpit\n```\n\nto link the package to the current user's Cockpit module directory. Log in to Cockpit and the module should be there. If you are already logged in, you will need to log out and in again to make it appear\n\n## Hot Reloading and Production Builds\n\nI've not yet figured out how to get hot reloading into Cockpit proper - in the interim `webpack-dev-server` can be used to test some changes quickly\n\n```\nnpm run build-dev-server\n```\n\nA minified build can also be produced for a proper deployment using\n\n```\nnpm run build-prod\n```\n\n## Modifying\n\nThe main modification you will need to make is in `manifest.json`, which contains the name of the module(s) as it is exposed to Cockpit.\n\nI have tried to keep this boilerplate as light as possible. It only includes the basics you need to get a simple Typescript/React app running.\n\nIt also only exposes one module - more can be added under `manifest.json`. You will likely then need to create separate Webpack build scripts for each module's source. \n\n## Removing\n\nIf you want to unlink the module from Cockpit, run\n\n```\nnpm run unlink-to-cockpit\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewlipscomb%2Fcockpit-typescript-react-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrewlipscomb%2Fcockpit-typescript-react-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewlipscomb%2Fcockpit-typescript-react-boilerplate/lists"}