Account: A tiny tool for accounts that account!

Postlight's Account is a markup format for making web pages like this:

Check out a live demo of Account, and read more about the project.

What is Account?

It's a tool for making short accounts, which are accounts that account for themselves using accounting.

In less annoying terms, it parses a tiny markup format and makes interactive web content with sliders. When you change a value in one slider it may change lots of other values.

My name is Paul Ford and I made it because I make a lot of little spreadsheets to work out how things work, and it's hard to share them and make them comprehensible. Plus it was a fun two-weekend project while we're all at home.

Now that I've made it I will return to it when I want to use it.

Why wouldn't I use Tangle/Idyll/Smalltalk-80/Excel?

You should use those, they do more and are better. Tangle, Idyll, Smalltalk-80, or a spreadsheet are tools for smart people who like code, or spreadsheet people who like numbers. Account is a tool for dumb people who like moving sliders around so they can watch the numbers go, like me.

How do I edit the text?

You don't yet, you have to pull this repository and make your own. I'm releasing early. Pull requests welcome.

Sample text

To make the page shown in the screenshot above, you'd write:

:cup_with_straw: You drink
{0-4:sodas_daily}
Diet Cokes per day, at a cost of
${0.00-3.50:soda_cost} per Diet
Coke.

If you'd put that into an index
fund with a {-10.00-12.00:annual_yield}%
annual rate of return, you'd have
${=((((sodas_daily * 365) * soda_cost) / 12) *
(((1 + ((annual_yield/100)/12)) ^ 120) - 1)
/ ((annual_yield/100)/12)):total}

within a decade. :+1:

That's the formula for compound interest I got off some website. I'm sure I screwed something up. Pull requests welcomed.

Notice that newlines don't really matter. They're not real and they can't hurt you. If you want to include spacing between lines you can't. Paragraphs were a wasteful orthographic indulgence by lazy monks and we don't allow them here.

What it does

Reads a text file, and by text I mean text.
Respects emojis between : colons like :+1:.
Respects two special bracketing formats:
1. {[single number or range]:[variable name]}
2. {=[expression]:[variable name]}

So:

{10-20:wholes} wholes is {=wholes * 2:halves} halves.

Yields:

=O= 15 wholes is 20 halves.

(Where =O= is a <input type="range"/> slider in HTML5.) And when you move the slider around the numbers change. Whoo hoo!
Numbers are just numbers, and can be negative (currently only on the left-hand-side of a statement, sorry!) or have decimal points.
If you use a dollar sign ala ${100:dollars} it will try to format things intelligently.
It'll try to keep the number of decimal points steady, i.e. if you type {0.00-100.00:rating} it'll format the output to the hundredth after the decimal. (Most of that stuff is hacky, YMMV.)
It respects Markdown-style link formatting, so [Wikipedia](https://www.wikipedia.org) will render <a href="https://wikipedia.org">Wikipedia</a>.

Under the hood

I run a software firm which means I'm an executive programmer: I did very little and delegated all the hard work to libraries, while taking all the credit.

Mathing

The thing that does the math is expr-eval, which has most of the regular functions you'd expect and is pretty nice about symbols, and is both fast and reliable after trying a few alternatives.

The math works like math.
You need to declare variables in the order you expect them to be evaluated; i.e. you can't declare x at the bottom of your document and expect x to be available at the top.

Parsing

The text is parsed by parsimmon, which was fun to learn, once I gave up on regular expressions and just accepted that I could concat unmatched text after parse.

Formatting

The numbers are formatted by numeral.js, which does what it says.

Hamburgling

Note as well the very fine React Hamburger Menu which gave this site a hamburger menu so that I didn't have to read through five React Hamburger Menu tutorials while cutting-and-pasting the one approach that would work with Router and React hooks 16.8 or greater.

Code Notes

This project was bootstrapped with Create React App. It has yet to be ejected.

If you'd like to run it locally, you can:

yarn install
yarn start

Could this be used for evil?

Yes, if people used it to "prove" things that are nonsense, like a Eugenics calculator about improving the genetic stock of humanity, or a calculator that proved that a certain percentage of humans must be turned into food.
C.f. also "How to Lie with Statistics."
I'll consider those risks as time passes. Since the only way to publish is to set up a whole new thingy on the web and deploy it, or to issue a pull request, the risk of malice is low.
The risk of incompetence is extremely high as always.

TODOs

Math
- Some sort of array generator so that you can do sigmas via the fold inside of the expr-eval math functions. Maybe you have something like {#48:months} and that knows to generate an array from [n..48] that you can then use in sigma functions to calculate IRR or what-have-you.
Interface
- A charting module, given the above; if I know I'm over 48 months then anyting that interacts with months returns an array, I should be able to drop a chart in there.
- A way to edit in the browser and save somehow or other. Since it's just ASCII maybe it could be hacked to just save into some simple CMS. It'd be fine except for then needing to set up accounts, and moderate, and do all the other things. Maybe it could just pull live from a Gist. Maybe I'll use some auth service like a young person.
- Live editing! Very simple because the parser is all JavaScript. Text on the left, live results on the right.
Content
- Many more fun calculators made of text.
- The ability to inline HTML.
- Citations so that we know where the math is coming from.
Design
- Actual design by designers who design

🔬 A Labs project from your friends at Postlight. Happy coding!

License

postlight/account

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 14

Uh oh!

Languages

Packages