January 2021 edition!
This doc seeks to help developers get a basic understanding of the CalChart redesign project and how to get started working on the codebase. https://github.com/calband/calchart-redesign
This video should give a good idea of how to debug the project and walk through the code base.
To follow along, you can use the same commit: git checkout f6ea8fcdab2b4300a03b0fc7bafea777769c3f1e https://github.com/calband/calchart-redesign/commit/f6ea8fcdab2b4300a03b0fc7bafea777769c3f1e
The redesigned CalChart is meant to be a web application. Currently there is no back-end... It is just front-end (HTML, CSS, JS)! This is different than Members Only, which also includes a back-end server running on the Django framework (Python).
Websites are made up of HTML, CSS, and JS.
The primary framework being used is Vue. This is comparable to React and Angular. Why use a framework? It helps make it easier, faster, and cleaner to write complicated user interfaces. For example, Vue automatically updates the UI when it detects changes to the state or data.
You can see a list of all third-party dependencies in our package.json (you will see this for Node.js projects). https://github.com/calband/calchart-redesign/blob/master/package.json
You do not need to understand these fully to get started, but here's a high-level breakdown:
These packages scan the code for common developer mistakes that can cause code errors. For example, eslint will warn you if you make a function with duplicate arguments e.g. function add(a, a) https://eslint.org/docs/rules/no-dupe-args