CodingTrain/Coding-Challenges

File Structure?

dipamsen opened this issue · 5 comments

I think we can/should start porting "non-p5 web editor" code from CodingTrain/website to here, otherwise the new website will have links to the old repo.

That said, I would like to know if there is a preferred file structure to be followed in this repo for code examples.

Yes! If you have any idea for how to best organize this I'm game! I haven't thought or planned this yet. My first guess would be to have each challenges numbered (w/ 3 digits so they sort properly?). So maybe the folders would be:

000_Starfield/
001_Menger_Sponge/
002_Snake_Game/

I am trying to simplify maintenance and reduce noise so I think that p5 examples could live solely in the web editor in which case this would be for Processing ports only? But I'm also ok with having them both? Which would be better:

p5/
  000_Starfield/
  001_Menger_Sponge/
  002_Snake_Game/
Processing/
  000_Starfield/
  001_Menger_Sponge/
  002_Snake_Game/

or

000_Starfield/
  p5/
  Processing/
001_Menger_Sponge/
  p5/
  Processing/
002_Snake_Game/
  p5/
  Processing/

I'll note that not all challenges are well suited to be ported to both environments. . and some challenges are node.js projects (and in the future might even be other languages!) For special cases, I can imagine an entirely separate repo being best for a given challenge. It could either be ignored here or linked from a README file in the challenge directory.

I think this repo can be used for the following:

  • Processing/Other Language Ports for the Coding Challenges
  • Processing/NodeJS/Other non-editor Code Examples for linking to the video page

Most of the p5 Code can stay in the p5.js Web Editor for consistency

As you mentioned, some challenges can have dedicated repos (CodingTrain/Monty-Hall), whereas some might not be able to be ported to other languages. These may not have a folder in this repo.

This all sounds great to me!!

I think we can close this, yes? @dipamsen

Yes!