Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jfoclpf/autocosts
The monorepo for the fully free and open source full-stack Car Costs Calculator for more than 30 countries
https://github.com/jfoclpf/autocosts
android-application automobile automobile-costs calculator calculator-application car car-costs cost expressjs fuel-efficiency handlebars javascript jquery nodejs standardjs uber website
Last synced: 2 months ago
JSON representation
The monorepo for the fully free and open source full-stack Car Costs Calculator for more than 30 countries
- Host: GitHub
- URL: https://github.com/jfoclpf/autocosts
- Owner: jfoclpf
- License: gpl-3.0
- Created: 2014-04-30T20:00:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-26T09:39:12.000Z (about 1 year ago)
- Last Synced: 2024-05-02T06:07:12.834Z (8 months ago)
- Topics: android-application, automobile, automobile-costs, calculator, calculator-application, car, car-costs, cost, expressjs, fuel-efficiency, handlebars, javascript, jquery, nodejs, standardjs, uber, website
- Language: JavaScript
- Homepage: https://autocosts.info
- Size: 104 MB
- Stars: 36
- Watchers: 2
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[![js-standard-style][js-standard-style_img]][js-standard-style_url]
[![npm module downloads][npm_module_downloads_img]][npm_module_downloads_url]
[js-standard-style_img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[js-standard-style_url]: https://standardjs.com/
[npm_module_downloads_img]: https://img.shields.io/npm/dt/autocosts.svg
[npm_module_downloads_url]: https://www.npmjs.com/package/autocosts
# autocosts
**The fully free and open source full-stack Car Costs Calculator for more than 30 countries**
This calculator gives users a good estimate of what they really need to spend on car ownership. As car payments and expenses come due throughout the year, it's often difficult to really get a good understanding of total spending on a car.
This calculator also provides to the user, optionally, the car's full Financial Effort considering the user's income, further providing also optionally the equivalent public transport costs (bus, train, UBER, etc.), considering the user doesn't own a car.
## Run it on your machine
1. Clone the project
`git clone https://github.com/jfoclpf/autocosts.git`
2. Enter in the newly created directory and install dependencies
`cd autocosts && npm ci --omit=dev`
3. Start the server
`npm start`
it will open a http local server which you can access through `http://localhost:3028`
## Website
https://autocosts.info
### Playground
https://autocosts.info/XX
### The list of available countries
https://autocosts.info/list
The translations are in corresponding `json` files, namely in the folder `src/countries/`.
The list of available countries is from the file `src/countries/list.json`
### World statistics of Car Costs
https://autocosts.info/worldstats
## How does it work?
Autocosts uses `nodejs`, `expressjs` and `handlebarsjs` to supply a server application that renders a car costs calculator as a webpage loaded by any common browser.
The project is optimized for a web-based version, and for an APP developped in Apache Cordova. The 2 last letters on the URI stands for the 2-letter ISO country code, and not for the language, since for example United Kingdom and Australia have the same language but different realities concerning the taxes, the terms applied to automobile costs and the units for fuel efficiency. The translations/language files apply therefore only to the selected country.
The project already considers all the units and fuel efficiency cases, different in many countries. The variations for fuel efficiency are `L/100km`, `km/L`, `mpg(US)`, `mpg(imp)` and for distance are `km`, `miles` and `mil` (Nordic mile=10km). More information can be found in the directory [`src/countries/`](src/countries/).
For more information regarding how the costs are calculated, you can check the [`src/client/core/`](src/client/core/) which is based on the 12 items that form the car costs for any given country. Namely they are:
* Standing costs
* Depreciation
* Car taxes
* Insurance
* Inspection
* Car finance
* Running costs
* Fuel
* Maintenance
* Repairs and Improvements
* Parking
* Tolls
* Fines
* Car washes
For more information see [`contributing.md`](contributing.md)
### Aditional services
Autocosts supports the following additional services, which can be enabled or disabled (default).
After building with `node build.js`, run `node bin/server.js -h` for more information.
### Database
Autocosts also supports code such that the user inputs might be stored into a `mysql` database. With the data from said database, it is also possible to make several statisitcal analysis, namely the average costs for each country, said statistical analysis having outlier removal techniques, such that such outliers do not distort the average.
### Uber
Autocosts may use the UBER API, such that at the final repport, the user calculations can be compared with the equivalents costs if the user would use just UBER or combined with public transports.
### PDF
Autocosts also allows the final report to be printed into a PDF report. It makes use of `pdfmake` npm package.
### Credentials file
The credentials for the above services are in the JSON files stored in [`credentials/`](/credentials/)
## API
The API works normally as any other npm API without the need to install any extra software.
Just install the API
`npm i autocosts`
Now use the autocosts API
```js
const autocosts = require('autocosts')
// see https://github.com/jfoclpf/autocosts/blob/master/contributing.md#standards
// for standard units and time periods
var userData = {
countryCode: 'US',
currency: 'USD',
depreciation: {
dateOfAcquisition: {
month: 5,
year: 2001,
valueOfTheVehicle: 25000
},
dateOfUserInput: {
month: 2,
year: 2020,
valueOfTheVehicle: 5000
}
},
insurance: {
amountPerPeriod: 200,
period: 'month'
},
credit: {
creditBool: true,
yesCredit: {
borrowedAmount: 15000,
numberInstallments: 48,
amountInstallment: 350,
residualValue: 0
}
},
inspection: {
averageInspectionCost: 120,
numberOfInspections: 15
},
roadTaxes: {
amountPerYear: 120
},
// Form Part 2
fuel: {
typeOfCalculation: 'distance', // type string: "money" or "distance"
currencyBased: {
amountPerPeriod: null,
period: null // type string: "month", "twoMonths", "trimester", "semester", "year"
},
distanceBased: {
considerCarToJob: true, // boolean
carToJob: {
daysPerWeek: 5,
distanceBetweenHomeAndJob: 15,
distanceDuringWeekends: 30,
distanceStandardUnit: 'mi' // standard distance for current country: "km", "mil" or "mil(10km)"
},
noCarToJob: {
distancePerPeriod: null,
period: null, // type string: "month", "twoMonths", "trimester", "semester", "year"
distanceStandardUnit: null // type string: "km", "mil" or "mil(10km)"
},
fuelEfficiency: 25, // fuel efficiency of the vehicle
fuelEfficiencyStandard: 'mpg(US)', // type string; "L/100km", "mpg(US)", etc.
fuelPrice: 2.5, // type number; currency per unit of volume standard. Ex: 1.4, that is 1.4 EUR / L
fuelPriceVolumeStandard: 'gal(US)' // type string: 'L', 'gal(imp)', 'gal(US)'
}
},
maintenance: {
amountPerYear: 700
},
repairsImprovements: {
amountPerYear: 200
},
parking: {
amountPerMonth: 14
},
tolls: {
calculationBasedOnDay: true, // true or false
yesBasedOnDay: {
amountPerDay: 2.5,
daysPerMonth: 22
},
noBasedOnDay: {
amountPerPeriod: null,
period: null // type string: "month", "twoMonths", "trimester", "semester", "year"
}
},
fines: {
amountPerPeriod: 40,
period: 'year' // type string: "month", "twoMonths", "trimester", "semester", "year"
},
washing: {
amountPerPeriod: 110,
period: 'year' // type string: "month", "twoMonths", "trimester", "semester", "year"
}
}
var results = autocosts.calculate(userData)
console.log(results)
```
The object `results` will be the following:
```json
{
"countryCode": "US",
"currency": "USD",
"costs": {
"totalPerYear": 6595.880952380952,
"totalEver": 123672.76785714286,
"perMonth": {
"items": {
"depreciation": 88.88888888888889,
"insurance": 200,
"credit": 8,
"inspection": 8,
"roadTaxes": 10,
"fuel": 78.26785714285715,
"maintenance": 58.333333333333336,
"repairsImprovements": 16.666666666666668,
"parking": 14,
"tolls": 55,
"fines": 3.3333333333333335,
"washing": 9.166666666666666
},
"standingCosts": 344.0555555555556,
"runningCosts": 205.60119047619048,
"total": 549.656746031746
},
"perUnitDistance": {}
},
"standardUnits": {
"speed": "mi/h",
"distance": "mi",
"fuelEfficiency": "mpg(US)",
"fuelPriceVolume": "gal(US)"
}
}
```
The financial effort of the user and alternative costs considering public transports, uber and taxis included, are also optionally calculated. See [the standard `userData` object](/contributing.md#userdata-class) for more information.
## Development
### Extra SW requirements
To development and fully build the app one further needs:
- `ImageMagick` (to compress images) and
- `Webdriver Manager` npm package to emulate Chrome and Firefox in the test suite
On Ubuntu/Debian one can run to install and configure them:
```
sudo apt install imagemagick -y
sudo npm i -g webdriver-manager
sudo webdriver-manager update --out_dir /usr/local/bin
sudo rm /usr/local/bin/*.zip /usr/local/bin/*.tar.gz
sudo mv /usr/local/bin/chromedriver* /usr/local/bin/chromedriver
sudo mv /usr/local/bin/geckodriver* /usr/local/bin/geckodriver
```
### Build
To custom build the app resources into the `bin/` directory, use the `build.js` node script at the root of the project. For more information run `node build.js --help`.
You have already standard configurations accessible in `package.json` which you can list by executing `npm run`.
### Running
After having built the app, to custom run it use the `bin/server.js` node script. For more information run `node bin/server.js --help`.
See also standard server configurations by executing `npm run`.
## Android APP
The Android APP can be found in Play Store. It uses Apache Cordova to convert JavaScript built code into APP built files (for example APK files in Android)
## About
### Contributing, data structure, flowcharts and coding rules
See [contributing](https://github.com/jfoclpf/autocosts/blob/master/contributing.md) and the [wiki pages](https://github.com/jfoclpf/autocosts/wiki)
### License
## Privacy
This calculator is and shall always be completely anonymous, as it doesn't request nor permanently store, any name, email, cookies, IP address nor any other personal information.