Add contributing instructions

README.md

@@ -35,6 +35,7 @@
   - [Built With](#built-with)
   - [Features](#features)
 - [Installation](#installation)
+- [Contributing](#contributing)
 - [License](#license)
 - [Roadmap](#roadmap)
 - [Contact](#contact)
@@ -157,6 +158,31 @@ 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.
 
+## Contributing
+
+### Dev Setup
+
+If you want to contribute to the project you need to set it up
+for development first.
+
+Fork and clone the project. Once you have it on your own machine,
+open up a terminal and navigate to the `server/` directory.
+
+In the `server/` directory run the command `go run main.go`.
+After some initial
+setup, the server should be listening on at port `3000`.
+
+Next, open a new terminal. Navigate to the `ui/` directory and run `npm install`.
+This will install all the dependencies for the frontend.
+After the command is done running, run `npm run dev`. After some output, the
+frontend should be accessible at `http://localhost:8080`.
+
+If you are sent straight to the login screen, try closing the page and opening
+it again. You should be greeted with a setup wizard the first time you run the
+project.
+
+Now, simply follow the instructions in order to set up your fresh install.
+
 ## License
 
 Distributed under the GPL-3.0 License. See `LICENSE` for more information.

docker-compose.yml

@@ -4,7 +4,7 @@ services:
     image: akhilrex/hammond
     container_name: hammond
     environment:
-      - JWT_SECRET=somethingverystrong
+      - JWT_SECRET = somethingverystrong
     volumes:
       - /path/to/config:/config
       - /path/to/data:/assets

server/controllers/auth.go

@@ -94,17 +94,17 @@ func userLogin(c *gin.Context) {
 	user, err := db.FindOneUser(&db.User{Email: loginRequest.Email})
 
 	if err != nil {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Not Registered email or invalid password")))
 		return
 	}
 
 	if user.CheckPassword(loginRequest.Password) != nil {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Not Registered email or invalid password")))
 		return
 	}
 
 	if user.IsDisabled {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("your user has been disabled by the admin. Please contact them to get it re-enabled")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Your user has been disabled by the admin. Please contact them to get it re-enabled.")))
 		return
 	}
 	UpdateContextUserModel(c, user.ID)
@@ -170,16 +170,16 @@ func changePassword(c *gin.Context) {
 	user, err := service.GetUserById(c.GetString("userId"))
 
 	if err != nil {
-		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("Not Registered email or invalid password")))
 		return
 	}
 
 	if user.CheckPassword(request.OldPassword) != nil {
-		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("incorrect old password")))
+		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("Incorrect old password")))
 		return
 	}
 
 	user.SetPassword(request.NewPassword)
-	success, _ := service.UpdatePassword(user.ID, request.NewPassword)
+	success, err := service.UpdatePassword(user.ID, request.NewPassword)
 	c.JSON(http.StatusOK, success)
 }

server/controllers/middlewares.go

@@ -23,8 +23,8 @@ func stripBearerPrefixFromTokenString(tok string) (string, error) {
 // Extract  token from Authorization header
 // Uses PostExtractionFilter to strip "TOKEN " prefix from header
 var AuthorizationHeaderExtractor = &request.PostExtractionFilter{
-	Extractor: request.HeaderExtractor{"Authorization"},
-	Filter:    stripBearerPrefixFromTokenString,
+	request.HeaderExtractor{"Authorization"},
+	stripBearerPrefixFromTokenString,
 }
 
 // Extractor for OAuth2 access tokens.  Looks in 'Authorization'

server/controllers/setup.go

@@ -51,7 +51,7 @@ func migrate(c *gin.Context) {
 		canMigrate, _, _ := db.CanMigrate(request.Url)
 
 		if !canMigrate {
-			c.JSON(http.StatusBadRequest, fmt.Errorf("cannot migrate database. please check connection string"))
+			c.JSON(http.StatusBadRequest, fmt.Errorf("cannot migrate database. please check connection string."))
 			return
 		}
 

server/controllers/vehicle.go

@@ -397,7 +397,7 @@ func deleteVehicle(c *gin.Context) {
 			return
 		}
 		if !canDelete {
-			c.JSON(http.StatusUnprocessableEntity, common.NewError("shareVehicle", errors.New("you are not allowed to delete this vehicle")))
+			c.JSON(http.StatusUnprocessableEntity, common.NewError("shareVehicle", errors.New("You are not allowed to delete this vehicle.")))
 			return
 		}
 		err = service.DeleteVehicle(searchByIdQuery.Id)

server/db/dbfunctions.go

@@ -117,7 +117,7 @@ func UnshareVehicle(vehicleId, userId string) error {
 		return nil
 	}
 	if mapping.IsOwner {
-		return fmt.Errorf("cannot unshare owner")
+		return fmt.Errorf("Cannot unshare owner")
 	}
 	result := DB.Where("id=?", mapping.ID).Delete(&UserVehicle{})
 	return result.Error
@@ -332,7 +332,8 @@ func UnlockMissedJobs() {
 		if (job.Date == time.Time{}) {
 			continue
 		}
-		var duration = time.Duration(job.Duration)
+		var duration time.Duration
+		duration = time.Duration(job.Duration)
 		d := job.Date.Add(time.Minute * duration)
 		if d.Before(time.Now()) {
 			fmt.Println(job.Name + " is unlocked")

server/service/fileService.go

@@ -3,6 +3,7 @@ package service
 import (
 	"archive/tar"
 	"compress/gzip"
+	"errors"
 	"fmt"
 	"io"
 	"net/http"
@@ -125,14 +126,14 @@ func CreateBackup() (string, error) {
 	tarballFilePath := path.Join(folder, backupFileName)
 	file, err := os.Create(tarballFilePath)
 	if err != nil {
-		return "", fmt.Errorf("could not create tarball file '%s', got error '%s'", tarballFilePath, err.Error())
+		return "", errors.New(fmt.Sprintf("Could not create tarball file '%s', got error '%s'", tarballFilePath, err.Error()))
 	}
 	defer file.Close()
 
 	dbPath := path.Join(configPath, "hammond.db")
 	_, err = os.Stat(dbPath)
 	if err != nil {
-		return "", fmt.Errorf("could not find db file '%s', got error '%s'", dbPath, err.Error())
+		return "", errors.New(fmt.Sprintf("Could not find db file '%s', got error '%s'", dbPath, err.Error()))
 	}
 	gzipWriter := gzip.NewWriter(file)
 	defer gzipWriter.Close()
@@ -150,13 +151,13 @@ func CreateBackup() (string, error) {
 func addFileToTarWriter(filePath string, tarWriter *tar.Writer) error {
 	file, err := os.Open(filePath)
 	if err != nil {
-		return fmt.Errorf("could not open file '%s', got error '%s'", filePath, err.Error())
+		return errors.New(fmt.Sprintf("Could not open file '%s', got error '%s'", filePath, err.Error()))
 	}
 	defer file.Close()
 
 	stat, err := file.Stat()
 	if err != nil {
-		return fmt.Errorf("could not get stat for file '%s', got error '%s'", filePath, err.Error())
+		return errors.New(fmt.Sprintf("Could not get stat for file '%s', got error '%s'", filePath, err.Error()))
 	}
 
 	header := &tar.Header{
@@ -168,12 +169,12 @@ func addFileToTarWriter(filePath string, tarWriter *tar.Writer) error {
 
 	err = tarWriter.WriteHeader(header)
 	if err != nil {
-		return fmt.Errorf("could not write header for file '%s', got error '%s'", filePath, err.Error())
+		return errors.New(fmt.Sprintf("Could not write header for file '%s', got error '%s'", filePath, err.Error()))
 	}
 
 	_, err = io.Copy(tarWriter, file)
 	if err != nil {
-		return fmt.Errorf("could not copy the file '%s' data to the tarball, got error '%s'", filePath, err.Error())
+		return errors.New(fmt.Sprintf("Could not copy the file '%s' data to the tarball, got error '%s'", filePath, err.Error()))
 	}
 
 	return nil

server/service/reportService.go

@@ -1,7 +1,6 @@
 package service
 
 import (
-	"sort"
 	"time"
 
 	"github.com/akhilrex/hammond/db"
@@ -16,9 +15,6 @@ func GetMileageByVehicleId(vehicleId string, since time.Time) (mileage []models.
 
 	fillups := make([]db.Fillup, len(*data))
 	copy(fillups, *data)
-	sort.Slice(fillups, func(i, j int) bool {
-		return fillups[i].OdoReading > fillups[j].OdoReading
-	})
 
 	var mileages []models.MileageModel
 

ui/public/index.html

@@ -5,7 +5,6 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
     <link rel="shortcut icon" href="<%= webpackConfig.output.publicPath %>hammond.png" />
-    <link rel="apple-touch-icon" href="<%= webpackConfig.output.publicPath %>touch-icon.png" />
     <title><%= webpackConfig.name %></title>
   </head>
   <body>