[![GitHub Actions](https://github.com/teamniteo/salarycalc/actions/workflows/ci.yml/badge.svg)](https://github.com/teamniteo/salarycalc/actions/workflows/ci.yml) [![Netlify Status](https://api.netlify.com/api/v1/badges/cccd17ab-57b5-48f2-8f5d-203432b99502/deploy-status)](https://app.netlify.com/sites/salarycalculator/deploys) # Niteo Salary Calculator A web app to calculate a salary of a [Niteo](https://niteo.co/) employee. Written in [Elm programming language](https://elm-lang.org/) it runs entirely on the client side. You can see it in action on https://niteo.co/salary-calculator. ## Installation ```shell npm install salary-calculator ``` ## Usage There are several scenarios. Pick the one that suits you the best. ### Serve from a sub-directory Assuming you have a website at `https://example.com/` with content served from the `public/` directory and want the calculator to be available at `https://example.com/salary-calculator/`, the easiest way is to copy (or link) the `dist` directory, like this: ```shell cp -r node_modules/salary-calculator/dist/ public/salary-calculator ``` ### Embedding in custom HTML document If you want to customize the stylesheet or want to embed it in your own HTML page, the easiest way is again to copy the `dist/` directory and then use a `

``` ### Using CommonJS or ES6 modules You can also use it as a CommonJS module: ```js const SalaryCalculator = require("salary-calculator"); ``` or ES6: ```js import * as SalaryCalculator from "salary-calculator" ``` This way it won't set any globals. The variable will be scoped to the module. Also you don't need to copy anything - just install and import. Otherwise it works the same as the HTML `script` tag. ## What is the purpose of this project? At Niteo we believe in [open and fair way of doing business](https://niteo.co/about). That's why the salary system is completely transparent. Using this app you can see who earns how much and why. We hope other companies can use it for the same purpose. ## Hacking Contributions are welcome. ### Prerequisites You need to have [Nix](https://nixos.org/download.html) installed. Once you do, running `nix-shell` will drop you into a shell that has all the tooling required for development ready for you. Additionally, to not have to remember to run `nix-shell` you can install `http://direnv.com/` and you will be dropped into the Nix shell automatically when `cd`-ing into the project. ### Local development 1. `git clone git@github.com:teamniteo/salarycalc.git && cd salarycalc` 1. `nix-shell` or `direnv allow`. 1. To start development server with hot reloading run `make run`. 1. To update currency rates, base salaries and location factors, run `make config`. 1. When you are happy with your code, run `make` to compile a production-optimized code in `dist/` directory. It will also run tests (with coverage analysis) and linters. ### Preparing for new year 1. Run `make config` to update the base salaries and location factors. 1. Run `make dist` to build the new version of the Salary Calculator. 1. `cd dist && python -m http.server` then point your browser to `http://localhost:8000/index.html`. 1. Staging: Go to JSFiddle and paste `dist/index.html` into HTML section, `dist/index.js` into JS section and click `Run`. 1. Update https://github.com/teamniteo/minisites/blob/main/src/minisites/sites/niteo_co/pages/salary-calculator.pt#L46 to point to the new release. ### Contributing Thanks for your interest in our project. We are open to learn about any issues and for your pull requests. ## We're hiring! At Niteo we regularly contribute back to the Open Source community. If you do too, we'd like to invite you to [join our team](https://niteo.co/careers)!