Stock options calculator

A web app which calculates the estimated value over time of employee stock options you have been allocated.

This calculator is aimed at people who are tax-resident in the UK except Scotland (contributions welcome - see below), and who have share options in UK-registered companies. It supports cases where you have options in multiple companies, as well as multiple vesting schedules.

The application is a standalone browser-based web application which does not require a back end server. It is written in TypeScript with React, and is built using Vite.

Feature requests and feedback

First, please check if your issue has already been raised for this project. If not, please do raise a new issue and provide as much context as possible.

Getting started with development

Dependencies

These need to be installed on your system:

1. Node.js
2. Yarn - this should usually just involve running corepack enable

Developing

Clone this repository. Then in its directory, run:

yarn

Run the Vite dev server to see your changes in the browser:

yarn dev

Run all unit tests (if you are actively changing code covered by unit test, you may find it useful to omit --watch=false to continuously run affected tests):

yarn test --watch=false

Run the linter:

yarn lint

Contributing

Contributions are very welcome! Please fork this repository and open a pull request.

Licence

This project is distributed under the GNU AGPL v3 licence. Among other things, it means that this code cannot be used in closed-source (proprietary) software. See LICENCE for details.