Resources & Documentation

Below are some common resources to assist you with your completion of this project. If you get stuck, start by consulting the following materials; if you have any additional questions, the course staff will be available to answer questions via Slack and Office Hours.

Git & GitHub Documentation

Documentation for working with Git and GitHub:

• Git Documentation
• Git Flow
• GitHub Basics
• GitHub's Flow
• GitHub Cross-Referencing

We also have a simple Git-based exercise that you are highly recommeneded to complete before proceeding with this project.

NodeBB Documentation

The official NodeBB documentation is available at https://docs.nodebb.org. The CMU-313 snapshot is a fork of v3.8.4.

When developing with NodeBB, the following documentation about internal REST API endpoints might be helpful: - Read API - Write API

If you want to run HTTP requests to interact with the REST API of a running NodeBB instance (e.g., on localhost), then you can use the curl tool to issue HTTP requests via the command-line. - Tutorial on using curl for testing a REST API