{"id":19177043,"url":"https://github.com/teamcodestream/codestream-guide","last_synced_at":"2025-04-20T02:35:02.103Z","repository":{"id":42696661,"uuid":"254409916","full_name":"TeamCodeStream/codestream-guide","owner":"TeamCodeStream","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-10T02:52:50.000Z","size":82519,"stargazers_count":0,"open_issues_count":7,"forks_count":1,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2023-03-05T04:28:23.685Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":false,"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/TeamCodeStream.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":"2020-04-09T15:31:07.000Z","updated_at":"2021-11-22T02:05:50.000Z","dependencies_parsed_at":"2023-01-21T09:15:42.396Z","dependency_job_id":null,"html_url":"https://github.com/TeamCodeStream/codestream-guide","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamCodeStream%2Fcodestream-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamCodeStream%2Fcodestream-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamCodeStream%2Fcodestream-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamCodeStream%2Fcodestream-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamCodeStream","download_url":"https://codeload.github.com/TeamCodeStream/codestream-guide/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223816623,"owners_count":17207890,"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":[],"created_at":"2024-11-09T10:31:48.189Z","updated_at":"2024-11-09T10:31:51.272Z","avatar_url":"https://github.com/TeamCodeStream.png","language":"Shell","readme":"# CodeStream User Guide\n\nThis repo is dedicated to the CodeStream User Guide which is one in a series of\nsimilar docs sites across the CodeStream ecosystem.\n\nThis site is statically generated with [Gatsby](https://www.gatsbyjs.org) using\nthemes created by the engineers of the [Apollo Data Graph\nPlatform](https://www.apollographql.com). These themes depend, in part, on\n[Space Kit](https://space-kit.netlify.app).\n\nGatsby is built on top of Node and React.\n\nThis site utilizes markdown and MDX for much of its content.\n\n## Prerequisites\n\n* Install either the CodeStream\n  [dev_tools](https://github.com/teamcodestream/dev_tools) tool kit or make sure\n  you have a recent version of [Node](https://nodejs.org). The dev_tools toolkit\n  will be needed if you plan to use the extended features for deployment and\n  builds.\n\n* Recommended VS Code extensions:\n\t- ESLint\n\t- Prettier\n\t- MDX\n\t- MDX Preview\n\t- React Native Tools\n\t- Rewrap\n\n## Installation\n\n### With dev_tools\n1.\tInstall the sandbox with a default name of **csg**\n\t```\n\t$ dt-sb-new-sandbox -yCD -t csguide -n csg\n\t```\n1.\tLoad your sandbox into the current shell.\n\t```\n\t$ dt-load csg\n\t```\n1.\tCreate a playground file with the default name of **csg** for your sandbox\n\t```\n\t$ dt-sb-create-playground -t sandbox/playgrounds/default.template\n\t```\n\nFrom this point forward, whenever you want to work on this project, simply load\nthe playground from a new shell with the command `dt-load-playground csg`.\n\n\n### Without dev_tools\n\n_**NOTE: Documentation and features will be limited without dev_tools.**_\n\n1.  Clone the repo, install the node modules and add the npm bin directory to\n    your search path.\n\t```\n\t$ git clone https://github.com/teamcodestream/codestream-guide.git\n\t$ cd codestream-guide/docs\n\t$ npm install --no-save\n\t$ export PATH=$PATH:node_modules/.bin\n\t```\n\n## Running gatsby in development mode\n\nAll of your work should eventually land on the **develop** branch, which is the\ndefault branch on the origin.\n\n1.\tRun gatsby in development mode from the **docs/** directory.\n\t```\n\t$ gatsby develop\n\t```\n1. Preview the site at http://localhost:8000\n\n\n## Consistent CodeStream Documentation Sites\n\nIn an effort to make consistent sites across all products in our platform, there\nare some files and folders in the **docs/src/** that are meant to be shared.\nUltimately, it would be nice to package them in a codestream theme to be used on\ntop of the apollo themes but that will take some work.\n\nFor now, they are:\n```\ndocs/src/\n      |-- codestream-config.js        # global codestream config data\n      |-- assets/codeStream/          # global codestream assets (icons, ...)\n      |-- components/                 # component overrides\n      |-- gatsby-theme-apollo-core/   # component shadowning from Apollo core theme\n      |-- gatsby-theme-apollo-docs/   # component shadowning from Apollo docs theme\n```\nTo create a tarball with these files, run `csg-make-cs-theme-pkg`\n\n## Other Resources\n\n* [Gatsby Documentation](https://www.gatsbyjs.org/docs/)\n* [Gatsby Apollo Core Theme](https://github.com/apollographql/gatsby-theme-apollo/tree/master/packages/gatsby-theme-apollo-core)\n* [Gatsby Apollo Docs Theme](https://github.com/apollographql/gatsby-theme-apollo/tree/master/packages/gatsby-theme-apollo-docs)\n* [Apollo's doc sites created with these themes](https://www.apollographql.com/docs/)\n* [Space Kit Icons](https://space-kit.netlify.app/?path=/story/icons--default)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamcodestream%2Fcodestream-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamcodestream%2Fcodestream-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamcodestream%2Fcodestream-guide/lists"}