README.md

Link to website

Contributing

All contributions are welcome

Project Structure:

• src
  • Components: All react components
    • Benchmark (/#/benchmark): Definitely needs improvement
    • Content (/#/)
    • Example: Example code on the landing page
    • Examples (/#/examples)
    • Header: The page header
    • Install (/#/install): Installation instructions, can be removed and be linked to the README
    • JellyOnFayyah: Glictchy Jellyfish GIF on landing page
    • Main (/#/): Header + Content
    • Nav: Navbar
    • OldVersions: Info about the first release etc., displayed at the bottom of the landing page
    • PageFooter: Footer
    • ScrollButton: A scroll-to-top btn
    • ServerBenchmarks: Graphs with gpu.js benchmarks on a server, displayed on the landing page
    • Strength: Features of gpu.js (like node.js compatibility), need to add more features (like expoGL support) too
    • Syntax: Supported Syntax in gpu.js, displayed on the landing page
    • Util: Common components
      • Code: Syntax Highlighted Codeblock
      • Graph: Graphs
      • Materialicon: easy to use single-component materialIcon
  • Data: All the graphs data
  • db: May want to move the graph data etc. to firebase in the future
  • img: Images and GIFs
  • scss: Global SASS files apart from the ones per component.

Currently Followed Conventions:

Coding Conventions

• Single line code is ended with a ; but multiline without it.

Naming

• All components are put inside separate directories with the same name as the component
• The main component file starts with a capital letter and is camelcased.
• Each component directory may have a scss file specific to that component, and should have the same name as the component.
• The component directories can have anything else.