You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
48
-
49
-
_Developers Note: This project is under active development which means I release new updates very frequently. It is recommended that you use something like [watchtower](https://github.com/containrrr/watchtower) which will automatically update your containers whenever I release a new version or periodically rebuild the container with the latest image manually._
37
+
Hammond is a self hosted vehicle management system to track fuel and other
38
+
expenses related to all of your vehicles.
39
+
It supports multiple users sharing multiple vehicles.
40
+
It is the logical successor to Clarkson which has not been updated for quite some time now.
41
+
This repo is again a fork of akhilrex's great [project](https://github.com/akhilrex/hammond).
50
42
51
-
__Also check out my other self-hosted, open-source solution - [Podgrab](https://github.com/akhilrex/podgrab) - Podcast download and archive manager and player.__
52
43
### Motivation and Developer Notes
53
44
54
-
I was looking for a fuel tracking system and stumbled upon Clarkson. Although it did most of what I needed it has not been updated for quite a lot of time. Since I had some bandwidth available as my previous open source project [Podgrab](http://github.com/akhilrex/podgrab) had become quite stable now, my first thought was to contribute to the Clarkson project only. I soon realized that the architecture that Clarkson had used was not really be that extensible now and would warrant a complete rewrite only. So I decided to build Hammond - The successor to Clarkson.
45
+
As mentioned, this project is a fork of
46
+
akhilrex's [project](https://github.com/akhilrex/hammond) which is no longer active.
47
+
To prevent the same from happeing to this project, we are seeking to add more
48
+
maintainers/collaborators who have access to merge PRs.
55
49
56
-
The current version of Hammond is written using GO for backend and Vuejs for the front end. Originally I had thought of using the same tech stack for both frontend and the backend so that it became easier for users and other developers to use, deploy and contribute. Which is why the first version of Hammond has a NestJS backend complete with all the bells and whistles (GraphQL, Prisma and what nots). But I eventually decided to rebuild the backend in GO just to keep the container size small. No matter how much you can optimize the sheer size of the node_modules will always add bulk to your containers. I host all my tools on my Raspberry Pi. It only makes sense to keep the container size as small as possible.
50
+
We are trying our best to update with new features and feedback is very welcome.
57
51
58
-
Also I had initially thought of a 2 container approach (1 for backend and 1 for the frontend) so that they can be independently maintained and updated. I eventually decided against this idea for the sake of simplicity. Although it is safe to assume that most self-hosters are fairly tech capable it still is much better to have a single container that you can fire and forget.
52
+
The project is written using Go for the backend and Vuejs for the front end.
59
53
60
54
![Product Name Screen Shot][product-screenshot][More Screenshots](Screenshots.md)
61
55
@@ -79,7 +73,7 @@ Also I had initially thought of a 2 container approach (1 for backend and 1 for
79
73
- Save attachment against vehicles
80
74
- Quick Entries (take a photo of a receipt or pump screen to make entry later)
81
75
- Vehicle level and overall reporting
82
-
- Import from Fuelly (more apps coming soon)
76
+
- Import from Fuelly and Drivvo
83
77
84
78
## Installation
85
79
@@ -90,24 +84,25 @@ The easiest way to run Hammond is to run it as a docker container.
90
84
Simple setup without mounted volumes (for testing and evaluation)
91
85
92
86
```sh
93
-
docker run -d -p 3000:3000 --name=hammond akhilrex/hammond
87
+
docker run -d -p 3000:3000 --name=hammond alfhou/hammond
94
88
```
95
89
96
90
Binding local volumes to the container
97
91
98
92
```sh
99
-
docker run -d -p 3000:3000 --name=hammond -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config"akhilrex/hammond
93
+
docker run -d -p 3000:3000 --name=hammond -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config"alfhou/hammond
100
94
```
101
95
102
96
### Using Docker-Compose
103
97
104
-
Modify the docker compose file provided [here](https://github.com/akhilrex/hammond/blob/master/docker-compose.yml) to update the volume and port binding and run the following command
98
+
Modify the docker compose file provided [here](https://github.com/alfhou/hammond/blob/master/docker-compose.yml)
99
+
to update the volume and port binding and run the following command
105
100
106
101
```yaml
107
102
version: '2.1'
108
103
services:
109
104
hammond:
110
-
image: akhilrex/hammond
105
+
image: alfhou/hammond
111
106
container_name: hammond
112
107
volumes:
113
108
- /path/to/config:/config
@@ -123,7 +118,10 @@ services:
123
118
124
119
### Build from Source / Ubuntu Installation
125
120
126
-
Although personally I feel that using the docker container is the best way of using and enjoying something like hammond, a lot of people in the community are still not comfortable with using Docker and wanted to host it natively on their Linux servers. Follow the link below to get a guide on how to build hammond from source.
121
+
Although personally I feel that using the docker container is the best way of using
122
+
and enjoying something like hammond, a lot of people in the community are still not
123
+
comfortable with using Docker and wanted to host it natively on their Linux servers.
124
+
Follow the link below to get a guide on how to build hammond from source.
127
125
128
126
[Build from source / Ubuntu Guide](docs/ubuntu-install.md)
129
127
@@ -197,25 +195,6 @@ Distributed under the GPL-3.0 License. See `LICENSE` for more information.
<ahref="https://www.buymeacoffee.com/akhilrex"target="_blank"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Buy Me A Coffee"style="width: 217px!important;height: 60px!important;" ></a>
0 commit comments