{"id":17,"date":"2023-09-13T08:43:43","date_gmt":"2023-09-13T08:43:43","guid":{"rendered":"http:\/\/harvard-open-data-project.local\/?page_id=17"},"modified":"2023-09-13T08:43:44","modified_gmt":"2023-09-13T08:43:44","slug":"website-guide","status":"publish","type":"page","link":"http:\/\/harvard-open-data-project.local\/website-guide\/","title":{"rendered":"Website Guide"},"content":{"rendered":"\n

The HODP website is built using a diverse stack of technologies, and this guide will help you understand how to work with them.<\/p>\n\n\n\n

Website Stack<\/strong><\/p>\n\n\n\n

The HODP website is built with:<\/p>\n\n\n\n

    \n
  1. React<\/a>: A JavaScript library for frontend development that allows us to declare UI elements as components and reuse them in different configurations.<\/li>\n\n\n\n
  2. Gatsby<\/a>: A static site generator that compiles the React code into plain HTML, CSS, and JavaScript as part of the build process. This, along with other optimizations, makes Gatsby sites extremely fast.<\/li>\n\n\n\n
  3. Sanity<\/a>: A content management system (CMS) that stores website data for articles, blog posts, team members, datasets, and pages in structured JSON objects. Since Sanity is a headless CMS, it only controls the data, not the presentation.<\/li>\n\n\n\n
  4. GraphQL<\/a>: A querying language used to retrieve data from Sanity in a predictable format.<\/li>\n\n\n\n
  5. Firebase<\/a>: A database that stores user data for the survey group and the predictions game.<\/li>\n\n\n\n
  6. Theme UI<\/a>: A styling framework that stores our style guide in one file. It handles sitewide themes, inline styles, and styled components.<\/li>\n<\/ol>\n\n\n\n

    Running the Site Locally<\/strong><\/p>\n\n\n\n

    To run the site on your local machine, you need to clone the website repository, navigate to the hodp-website<\/code> directory, switch branches to v2-styling<\/code>, install the dependencies, and run the site. The website will run locally at localhost:8000<\/code>.<\/p>\n\n\n\n

    Developing an Interactive Component<\/strong><\/p>\n\n\n\n

    The guide recommends developing your component in a separate repository before transferring it to the HODP codebase. It details the steps you need to follow to create a new component, test it, and add it as an option to the general ReactComponent type of block content. Once your changes are approved, they will be merged into the main branch.<\/p>\n\n\n\n

    Troubleshooting<\/strong><\/p>\n\n\n\n

    If you encounter errors, the guide provides tips on how to debug general issues and D3 development issues. You can reach out to the tech team if you need further assistance.<\/p>\n\n\n\n

    Codebase Outline<\/strong><\/p>\n\n\n\n

    The hodp-website<\/code> repo stores two websites. The studio<\/code> directory controls the content structure and the frontend of the Sanity studio, while the web<\/code> directory stores the code for the main website.<\/p>\n\n\n\n

    Remember, if you need to install node packages, install them in the web<\/code> directory, not the general hodp-website<\/code> directory. If you install them in the general directory, they\u2019ll work locally, but they won\u2019t be recognized in deployment.<\/p>\n","protected":false},"excerpt":{"rendered":"

    The HODP website is built using a diverse stack of technologies, and this guide will help you understand how to work with them. Website Stack The HODP website is built with: Running the Site Locally To run the site on your local machine, you need to clone the website repository, navigate to the hodp-website directory, switch branches … Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"_links":{"self":[{"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/pages\/17"}],"collection":[{"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/comments?post=17"}],"version-history":[{"count":1,"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/pages\/17\/revisions"}],"predecessor-version":[{"id":18,"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/pages\/17\/revisions\/18"}],"wp:attachment":[{"href":"http:\/\/harvard-open-data-project.local\/wp-json\/wp\/v2\/media?parent=17"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}