{"id":13596148,"url":"https://github.com/mmulet/code-relay","last_synced_at":"2025-04-05T23:12:45.199Z","repository":{"id":44748933,"uuid":"326038845","full_name":"mmulet/code-relay","owner":"mmulet","description":"Source for the Code Relay website. Code Relay The fastest and easiest way to contribute to open source!","archived":false,"fork":false,"pushed_at":"2024-07-08T11:16:45.000Z","size":9184,"stargazers_count":326,"open_issues_count":9,"forks_count":21,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-29T22:09:12.416Z","etag":null,"topics":["contributing","contributors","maintainers","open-source"],"latest_commit_sha":null,"homepage":"https://www.coderelay.io","language":"TypeScript","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/mmulet.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-01T19:01:48.000Z","updated_at":"2025-03-24T07:23:22.000Z","dependencies_parsed_at":"2024-01-16T22:20:59.405Z","dependency_job_id":"eb6d3f2d-fa75-4305-bcbf-a02a827c179e","html_url":"https://github.com/mmulet/code-relay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmulet%2Fcode-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmulet%2Fcode-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmulet%2Fcode-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmulet%2Fcode-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmulet","download_url":"https://codeload.github.com/mmulet/code-relay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411240,"owners_count":20934653,"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":["contributing","contributors","maintainers","open-source"],"created_at":"2024-08-01T16:02:09.940Z","updated_at":"2025-04-05T23:12:45.177Z","avatar_url":"https://github.com/mmulet.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# coderelay.io\n\nThis is the source for the code-relay website.\n\n---\n# What is code relay?\n\nCode Relay is a platform for contributing to open source code. What makes code relay unique is that instead of writing a whole bug fix, you make incremental progress and then pass it along to the next contributor. Like how you only run part of a race in a relay race and then pass the baton off to the next runner.\nLearn more at [coderelay.io](https://www.coderelay.io)\n\n---\n\n## Looking for the repo for the back-end code?\n\nThere isn't one, yet. Right now, I ([@mmulet](https://github.com/mmulet)) answer all emails personally.\nWhen code relay grows large enough that it needs an automated backend,\nI intend to build it using code relay, and it will be open source.\n\n---\n\nThe content is all plain html, but we do have some\njavascript for interactive animations and other fun things.\nIn the true spirit of web-development, we have re-invented the wheel\nand created a custom build system using React/React-dom server.\nNamely, we wrote the whole site with React components, which we generate\nahead of time and serve as plain html. Read more about this in ./scripts/README.md.\n\n## Structure\n\nHere are the folders and their meanings:\n\n- `docs` folder is where all user facing content goes.\n  The server serves all files in the `docs` folder as `/`\n\n- `gulp` folder is where all files for the gulp build system go.\n  These are all typescript files. These files are all compiled on the fly by ts-node\n\n- `scripts` folder is where all source files for the website reside.\n\n## Development\n\nInstall dependencies:\n\n```\nnpm install .\n```\n\nThen, generate the site.\n\n```\nnpm run build\n```\n\n---\n\nUse npm run dev to start the gulp file which will watch all sources and generate on the fly with live-reload\n\n```\nnpm run dev\n```\n\nSet the environment variable CODE_RELAY_DEV_PORT to change the port. The default is 5000.\n\nAll the code for the site is in the ./scripts/src directory\n\n# How to read the code\n\n- Start at `./gulpfile.ts` to see how it is built\n- This should lead you to `./scripts/src/index.ts` which will generate all files.\n- From there look at each file in `./scripts/src/fileGenerators`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmulet%2Fcode-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmulet%2Fcode-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmulet%2Fcode-relay/lists"}