# Project Overview
See the homepage for an introduction to the project.
# Application Repos
- Customer-facing application (opens new window)
- Designed for mobile use (iOS/Android)
- Clerk-facing application (opens new window)
- Designed for iOS/Android tablet use
- Backend server (opens new window)
- Runs a scheduled job to port data from the Appian API to Airtable (production base)
- Written in Node.js using an Express server. Deployed with Heroku to https://healthycorners-rewards-node.herokuapp.com/. (opens new window)
- Documentation site (opens new window)
- This website! See the homepage for details.
- (Outdated) backend server (opens new window)
- CURRENTLY UNUSED. Contains outdated code to work with push notifications; if necessary, the code should be moved to the
dccentralkitchen-node
repo and refactored for updated usage.
- CURRENTLY UNUSED. Contains outdated code to work with push notifications; if necessary, the code should be moved to the
# Design
Go to the design prototypes page (linked in the navbar) to see the Figma project, as well as various resources.
# Known Issues
We use GitHub's built-in issue tracker to track issues we are aware of (e.g the customer repo (opens new window)). Looking at open issues may be helpful when attempting to triage or fix bugs.
Additionally, we've done our best to document our work/thought process throughout development via the PR descriptions. We also used "Squash and merge" for almost all PRs, so running git blame
from main
and then inspecting the source PR(s) from a particular commit may be helpful as well.
# Navigating this site
Relevant documentation, including instructions for onboarding and setting up local environments, development lifecycle, etc can be found in the individual subpages:
The Managing & Deploying Apps section contains documentation that is shared between two or more of our repos.
Future development: Please take a look at this page when considering changes, new features, etc.
Navbar: For convenience, the PROD
base, DEV
base, and Airtable workspace are linked, as well as all three of the active GitHub repos.