Skip to content
Jennifer Lu edited this page Dec 19, 2020 · 3 revisions

Welcome!

Things you may want to learn before starting to work on this codebase

  • Basics of HTML and CSS -> imperative!
  • Basics of React - this will make your life a lot easier.

Directory structure

  • Page routing (basically telling the website where everything is located) occurs at src/App.js.
  • Individual pages (such as Home, About, etc.) are their own directories under src/.
    • Each individual page's directory has an img/ folder that carries the images specific to that page.
    • Some individual page's directories may have a data/ folder. This means that there are certain parts of the page that we think can be edited by anyone without strong knowledge of the codebase, and those parts are here.
    • The index.js files are just what automatically gets run by the router, and they direct to the "page".js file.
  • Components that are not pages (such as footer, navbar, buttons) are under src/components.
  • Images that don't belong to a specific page are under src/img.

Final things to keep in mind

  • When adding images, please make sure to resize them so that they don't take forever to load for people with less internet bandwidth.
  • Tech debt can add up quickly - please make sure to keep your variable names clear and your code readable.
  • When in doubt, ask Adhiv/Jen!

Previous contributors

  • Fall 2020: Jen, Adhiv, Abi, Ivan, Arth
  • Pre-2020: Naomi, Pranav