49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
## About The Project
|
|
|
|
Hammond is a self hosted vehicle management system to track fuel and other expenses related to all of your vehicles.
|
|
It supports multiple users sharing multiple vehicles.
|
|
It is the logical successor to Clarkson which has not been updated for quite some time now.
|
|
This repo is again a fork of akhilrex's great [project](https://github.com/akhilrex/hammond).
|
|
|
|
### Motivation and Developer Notes
|
|
|
|
As mentioned, this project is a fork of akhilrex's [project](https://github.com/akhilrex/hammond) which is no longer active.
|
|
To prevent the same from happeing to this project, we are seeking to add more maintainers/collaborators who have access to merge PRs.
|
|
|
|
We are trying our best to update with new features and feedback is very welcome.
|
|
|
|
The project is written using Go for the backend and Vuejs for the front end.
|
|
|
|
### Built With
|
|
|
|
- [Go](https://golang.org/)
|
|
- [Go-Gin](https://github.com/gin-gonic/gin)
|
|
- [GORM](https://github.com/go-gorm/gorm)
|
|
- [SQLite](https://www.sqlite.org/index.html)
|
|
- [VueJS](https://vuejs.org/)
|
|
- [Vuex](https://vuex.vuejs.org/)
|
|
- [Buefy](https://buefy.org/)
|
|
|
|
#### Fresh setup
|
|
|
|
You will have to provide your name, email and password so that an admin user can be created for you.
|
|
|
|
Once done you will be taken to the login page.
|
|
|
|
Go through the settings page once and change relevant settings before you start adding vehicles and expenses.
|
|
|
|
## License
|
|
|
|
Distributed under the GPL-3.0 License. See `LICENSE` for more information.
|
|
|
|
## Roadmap
|
|
|
|
- [ ] More reports
|
|
- [ ] Vehicle specific reminders (servicing etc)
|
|
- [ ] Native installer for Windows/Linux/MacOS
|
|
|
|
## Contact
|
|
|
|
Project Link: [https://github.com/AlfHou/hammond](https://github.com/AlfHou/hammond)
|
|
|
|
[product-screenshot]: images/screenshot.jpg |