https://github.com/datahappy1/go_fuzzymatch_webapp

Fuzzster - fuzzy matching web application
https://github.com/datahappy1/go_fuzzymatch_webapp

bootstrap bundle-frontend fetch-api fuzzy-matching fuzzymatch-webapp golang heroku-deployment herokuapp javascript javascript-fetch-api levenshtein-distance mux rest-api restful-api webpack webpack-command

Last synced: about 1 year ago
JSON representation

Fuzzster - fuzzy matching web application

• Host: GitHub
• URL: https://github.com/datahappy1/go_fuzzymatch_webapp
• Owner: datahappy1
• License: mit
• Created: 2021-01-13T21:15:06.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-09-06T08:33:52.000Z (over 4 years ago)
• Last Synced: 2025-01-27T15:47:36.174Z (about 1 year ago)
• Topics: bootstrap, bundle-frontend, fetch-api, fuzzy-matching, fuzzymatch-webapp, golang, heroku-deployment, herokuapp, javascript, javascript-fetch-api, levenshtein-distance, mux, rest-api, restful-api, webpack, webpack-command
• Language: Go
• Homepage: https://fuzzster.herokuapp.com
• Size: 1.3 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# go_fuzzymatch_webapp

[![Go Report Card](https://goreportcard.com/badge/github.com/datahappy1/go_fuzzymatch_webapp)](https://goreportcard.com/report/github.com/datahappy1/go_fuzzymatch_webapp)

[![DeepScan grade](https://deepscan.io/api/teams/13362/projects/16364/branches/348988/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=13362&pid=16364&bid=348988)

A fuzzymatching web application written using Go and Javascript. 

## How to run locally the application back-end

1) Install `Golang 1.15+`

2) set environment variable name `environment` to `development` in your IDE

3) `go\src\github.com\datahappy1\go_fuzzymatch_webapp>go mod vendor`

4) `go\src\github.com\datahappy1\go_fuzzymatch_webapp>go run main.go`

- The API by default runs at http://localhost:8080/api/v1/requests/

- API Documentation is located [here](https://github.com/datahappy1/go_fuzzymatch_webapp/blob/main/ui/src/api_documentation.js)

- For back-end configuration, check files [here](https://github.com/datahappy1/go_fuzzymatch_webapp/tree/main/api/config)

- For running local tests, run `go\src\github.com\datahappy1\go_fuzzymatch_webapp>go test`

## How to run locally the application front-end

1) Install `npm`

2) Install `Webpack` based on [this tutorial](https://webpack.js.org/guides/installation/)

3) For local development, bundle frontend code using Webpack `go\src\github.com\datahappy1\go_fuzzymatch_webapp\ui>npm run build:development`

- For production release, bundle frontend code using Webpack `go\src\github.com\datahappy1\go_fuzzymatch_webapp\ui>npm run build:production`

- The application by default runs at http://localhost:8080/

## Screenshot of the app

![image](https://github.com/datahappy1/go_fuzzymatch_webapp/blob/main/app_screenshot.PNG)