https://github.com/angular2guy/reactandgo

A project with React in the frontend and Go/Gin/Gorm in the backend, MQTT Messaging, Cron Jobs and a Postgresql Db. Db schema updates are done with Gorms Migrator. Security is done with Golang-Jwt. Structurizr is used for C4 diagrams.
https://github.com/angular2guy/reactandgo

gin gin-gonic go golang golang-jwt gorm gorm-migration gorm-orm makefile mqtt mui mui-material npm paho-mqtt react reactjs recoil structurizr typescript

Last synced: 2 months ago
JSON representation

A project with React in the frontend and Go/Gin/Gorm in the backend, MQTT Messaging, Cron Jobs and a Postgresql Db. Db schema updates are done with Gorms Migrator. Security is done with Golang-Jwt. Structurizr is used for C4 diagrams.

• Host: GitHub
• URL: https://github.com/angular2guy/reactandgo
• Owner: Angular2Guy
• License: apache-2.0
• Created: 2022-12-31T12:44:02.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T10:39:59.000Z (about 1 year ago)
• Last Synced: 2024-04-13T20:51:43.937Z (about 1 year ago)
• Topics: gin, gin-gonic, go, golang, golang-jwt, gorm, gorm-migration, gorm-orm, makefile, mqtt, mui, mui-material, npm, paho-mqtt, react, reactjs, recoil, structurizr, typescript
• Language: Go
• Homepage: https://angular2guy.wordpress.com
• Size: 18.6 MB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ReactAndGo

This is a project to compare a single page application frontend based on React and a Rest backend based on Go, to Angular frontends and Spring Boot/Java backends. It enables the car drivers to find gas prices below an user defined target price. It sends notifications if the target price is reached and shows the prices matches in a table. The gas prices of the location of the user are shown in a table and on a map with with pins and hovers. The frontend uses React/Typescript  with Recoil for the state, Mui for the components and Openlayers for the map. The backend uses Go with Gin for the controllers with Jwt Token for security and Gorm for database access. Postgresql is used as database and for the MQTT messaging is the Paho library used. For development Apache Artemis is used as messaging system. The gas stations are imported every night and the state/county averages are recalculated every night with help of the go-cron library. Every night the average price updates of the last day for the fuel types in each county are calculated for timeslots. The average movements are displayed in bar charts for each timeslot together with the price target matches. 

Technologies: Go/Golang, Gin, Gorm, Paho, React, Recoil, Typescript, Recoil, Mui, Recharts, Openlayers, Structurizr

[![CodeQL](https://github.com/Angular2Guy/ReactAndGo/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Angular2Guy/ReactAndGo/actions/workflows/codeql-analysis.yml)

## Articles

* [Comparing the efficency of a Spring Boot project as GraalVm native image and on the Jdk to a Go project](https://angular2guy.wordpress.com/2023/10/21/comparing-the-efficiency-of-a-spring-boot-project-as-graalvm-native-image-and-on-the-jdk-to-a-go-project/)

* [Adding a gas station map to ReactAndGo](https://angular2guy.wordpress.com/2023/06/16/adding-a-gas-station-map-to-reactandgo/)

* [Cron Jobs and MQTT Messaging in Go](https://angular2guy.wordpress.com/2023/03/27/cron-jobs-and-mqtt-messaging-in-go/)

* [The ReactAndGo Architecture and Gorm DB access](https://angular2guy.wordpress.com/2023/02/26/the-reactandgo-architecture-and-gorm-db-access/)

* [Notifications from React frontend to Go/Gin/Gorm backend](https://angular2guy.wordpress.com/2023/03/09/notifications-from-react-frontend-to-go-gin-gorm-backend/)

## Features

1. Automatic database init on startup.

2. Nightly cronjob with http data import.

3. Datamanagement with Gorm for querys, mutations and automatic mapping.

4. Messaging is done with MQTT with the Paho library and Apache Artemis for development. 

5. Serve the frontend with a controller for the frontend and routes to the rest endpoints. 

6. The security is done with Jwt Tokens that can be revoked.

7. The frontend shows the prices matches and the local prices in a Mui Table with React/Typescript.

8. Price matches are shown as notifications. 

9. The local prices are shown on a map with openlayers at the locations of the gas stations.

10. The average gas prices of the states and counties are recalculated every night and updated with every MQTT message. They are shown in the gas price table.

11. The average gas price movements of the last day are calculated for timeslots to show when price movements happen and what their new prices are.

## Mission Statement 

The ReactAndGo project serves as example for the integration of React, Go, Gin, Gorm and Postgresql in a structured architecture. The build is integrated in one Makefile and the application can be build in a Docker image with the Dockerfile. As documentation are the structurizr diagrams as images and sources available.

## Postgresql setup

The database can be run as Docker image with the commands in the 'docker-postgres.sh' script. 

## Apache MQ Artemis

The Messaging server can be run as Docker image with the commands in the 'docker-artemis.sh' script. 

## Dataimport

To have historic data the DB dumps([https://creativecommons.tankerkoenig.de/](https://creativecommons.tankerkoenig.de/)) can be imported. After the import the performance with a large dataset can be assest. The data for the postcodes can be found at [suche-postleitzahl.org/download](https://www.suche-postleitzahl.org/downloads) the files are "plz-5stellig.geojson" and "zuordnung_plz_ort.csv".The file "plz-5stellig.geojson" needs to be gzipped, have to be available in the "/tmp/" directory and imported with this url: "localhost:3000/config/updatepc?filename=plz-5stellig.geojson.gz"(A valid Jwt token is needed). The file "zuordnung_plz_ort.csv" needs to be gzipped, have to be available in the "/tmp/" and imported with this url: "localhost:3000/config/updatestatescounties?filename=zuordnung_plz_ort.csv.gz". The Postcode files are imported to enable the county search by name and the county/state average price calculation.

## C4 Architecture Diagrams

The project has a [System Context Diagram](structurizr/diagrams/structurizr-1-SystemContext.svg), a [Container Diagram](structurizr/diagrams/structurizr-1-Containers.svg) and a [Component Diagram](structurizr/diagrams/structurizr-1-Components.svg). The Diagrams have been created with Structurizr. The file runStructurizr.sh contains the commands to use Structurizr and the directory structurizr contains the dsl file.

## Development Environment

Visual Studio Code with the Go Extension works well as IDE for the frontend and the backend.