Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 2.91 KB

README.md

File metadata and controls

36 lines (24 loc) · 2.91 KB

gomithrilapp

Go Report Card Build Status Coverage Status

Swagger Validator

This is a sample notepad application that uses Mithril with JSX on the front-end (UI) and Go on the back-end (API). This project is designed to show good development and CI/CD practices as well as integrations between modern development tools.

Documentation is generated using Docusaurus and hosted using GitHub Pages. This project uses a Makefile to centralize frequently used commands. The code coverage badge above is only for the back-end API - not the front-end.

Demo gif

Quick Start with Docker Compose

To test the application locally, you can follow these instructions. You don't need any of the the dev tools (Go/npm) installed, you only need Docker (and Docker Compose). The Go application serves both the UI and the API depending on the request URL.

Additional Documentation

Below are links to various section of the documentation.

This is one repository of a few that demonstrate with different front-end frameworks how to build a notepad application with authentication. A few of the other repositories are: