@per-diem-calculator/vanilla 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/dist/index.js +2502 -2352
- package/dist/index.umd.cjs +417 -289
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1 +1,60 @@
|
|
|
1
1
|
# Per Diem Calculator
|
|
2
|
+
|
|
3
|
+
Open source per diem calculator for both domestic and international trips. Built in TypeScript with Tailwind. Rates sourced directly from General Services Administration (GSA), Dept. of State, and Dept. of Defense (DOD).
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Lookup both domestic and international rates in one place and get accurate deductions for first/last day and meals provided
|
|
8
|
+
- print expense report PDF that includes daily breakdown, rates used, and links to the original federal source
|
|
9
|
+
- Full keyboard-only navigation support
|
|
10
|
+
- TK accessibility compliance
|
|
11
|
+
- Developers: calculator outputs expenses as object that can be easily incorporated into other tools
|
|
12
|
+
|
|
13
|
+
## Issues resolved
|
|
14
|
+
|
|
15
|
+
- No existing calculator for end users that lets them lookup both domestic and international rates, and also lets them deduct meals provided
|
|
16
|
+
- No existing calculator for developers to integrate into their expense management system
|
|
17
|
+
- No API for OCONUS rates from Dept. of State and Dept. of Defense
|
|
18
|
+
|
|
19
|
+
## Who this is for
|
|
20
|
+
|
|
21
|
+
- Individuals who want to quickly and easily look up their lodging and meals per diem allowances - https://perdiemcalc.org
|
|
22
|
+
- Developers who want to integrate into their expense platform - see console in https://perdiemcalc.org/object to outputted expense object that can be incorporated into projects
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
- https://perdiemcalc.org
|
|
27
|
+
- Develop locally
|
|
28
|
+
|
|
29
|
+
## Local Development
|
|
30
|
+
|
|
31
|
+
- deploy per diem proxy - https://github.com/ahmad-dowla/per-diem-calculator-proxy
|
|
32
|
+
- VITE_PROXY_KEY, VITE_PROXY_URL, GSA_API_KEY
|
|
33
|
+
-
|
|
34
|
+
|
|
35
|
+
## Config
|
|
36
|
+
|
|
37
|
+
- Expense object printed to console - https://perdiemcalc.org/object/
|
|
38
|
+
- Unstyled - https://perdiemcalc.org/unstyled/
|
|
39
|
+
|
|
40
|
+
## Behind scenes
|
|
41
|
+
|
|
42
|
+
GSA API
|
|
43
|
+
DOD zip files unpacked with JSZIP, parsed with DOMParser and XPathEvaluator
|
|
44
|
+
API calls reduced with memoization and caching results in Cloudflare on the proxy side
|
|
45
|
+
|
|
46
|
+
## Built with
|
|
47
|
+
|
|
48
|
+
TypeScript - native web components encapsulated in shadow DOM
|
|
49
|
+
Tailwind
|
|
50
|
+
TomSelect for searchable dropdowns
|
|
51
|
+
JSZip to unpack
|
|
52
|
+
DOMPurify to santize developer config object
|
|
53
|
+
|
|
54
|
+
## Planned Updates
|
|
55
|
+
|
|
56
|
+
- Dark mode
|
|
57
|
+
- Add CSS paths to make it easy to style shadowDOM elements
|
|
58
|
+
- CDN option
|
|
59
|
+
- Option to display rates only vs calculating expenses
|
|
60
|
+
- React version
|