This is the source for the code-relay website.
What is code relay?
Code 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. Learn more at coderelay.io
Looking for the repo for the back-end code?
There isn't one, yet. Right now, I (@mmulet) answer all emails personally. When code relay grows large enough that it needs an automated backend, I intend to build it using code relay, and it will be open source.
Here are the folders and their meanings:
docsfolder is where all user facing content goes. The server serves all files in the
gulpfolder is where all files for the gulp build system go. These are all typescript files. These files are all compiled on the fly by ts-node
scriptsfolder is where all source files for the website reside.
npm install .
Then, generate the site.
npm run build
Use npm run dev to start the gulp file which will watch all sources and generate on the fly with live-reload
npm run dev
Set the environment variable CODE_RELAY_DEV_PORT to change the port. The default is 5000.
All the code for the site is in the ./scripts/src directory
How to read the code
- Start at
./gulpfile.tsto see how it is built
- This should lead you to
./scripts/src/index.tswhich will generate all files.
- From there look at each file in