Callandor

Development

The password for the example site is password.

$ git clone https://github.com/cameron-yee/callandor
$ yarn start

Usage

Define categories and sub-categories in constants.ts. The data structure must stay the same. Each category object has a name property and a list of sub-category objects. Each sub-category object has a name property.

Edit pages/index.tsx to customize what shows up on the dashboard.

Example

<Dashboard
  categories={['social']}
  fixedItems={true}
  subCategories={['groceries', 'coffee']}
  yearLook={true}
/>

Data Entry

To enter data, add objects to src/data/budget.json, src/data/incomes.json, src/data/purchases.json, and optionally src/data/recurring.json. The data format is used to render components, so make sure to keep all the field names the same. The dashboard information is based on data in these three files.

For batch adding purchases, I recommend using excel2json-3. In the Excel file, create columns labeled date, amount, category, subCategory, and notes. Set the date column to type text and the amount column type to number. Once you convert the file, you can append the objects directly to the purchases.json file.

NOTE: Recurring items can be duplicated in purchases.json so be careful if you do not want these to be double counted.

Options

• categories: list of category names to display information about on the dashoard
• subCategories: list of sub-category names to display information about on the dashoard
• fixedItems (true/false): include fixed information on the dashboard
• recurring (true/false): include recurring items in monthly budget
  • If true, set up recurring items in src/data/recurring.json.
• yearLook (true/false): include net information for months of the selected year on the dashboard

Deployment

Fork the repository and make it a private repo.

Deploy to Netlify using the default settings or to any other static site deployer.

Security

I recommend setting up Netlify Access Control to protect your site behind password protection if you have a paid version of Netlify. This will provide server level security.

As a hack, I'm using StatiCrypt to encrypt/decrypt a password in the browser. This is easy to get around, but it will stop people who just happen to stumble across your site. This password is set in the encrypt script in package.json. This will only work at all if you keep your fork private.