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 Ed Discussions and Office Hours.
STUDENTS.md comes first
Everything on this page is general background. Start instead with STUDENTS.md in
the root of your team repository — it is written for this course and covers getting your
specific project set up and running.
After that, the most useful documentation is what your project already ships: its
README.md, CONTRIBUTING.md, architecture notes, and official docs site. Read those
before you reach for anything here.
Git & GitHub Documentation¶
Documentation for working with Git and GitHub:
Some of what you completed for Assignment 1 will be useful here!
Per-Project Documentation¶
| Project | Docs | Contributing guide |
|---|---|---|
| Actual Budget | actualbudget.org/docs | Contributing |
| Excalidraw | docs.excalidraw.com | Contributing |
| Gitea | docs.gitea.com | Hacking on Gitea |
| Medusa | docs.medusajs.com | Contributing |
| Chatwoot | chatwoot.com/docs | Contributing |
| Discourse | meta.discourse.org | Dev install guide |
| Cal.diy | cal.diy | See the repository CONTRIBUTING.md |
| Outline | getoutline.com/developers | See the repository CONTRIBUTING.md |
Language and Framework Background¶
Six of the eight projects are written primarily in TypeScript, and most of those use React. If that is your team's stack and you are new to it, the lectures below from Dr. Moran's previous Web App Development course are a good starting point, along with the Mozilla MDN documentation.
If your team is on Gitea, you will want A Tour of Go instead. If you are on Chatwoot or Discourse, start with the Ruby on Rails Guides, plus Vue or Ember respectively for the frontend.