Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/josephspurrier/gomithrilapp

Sample notepad application in Mithril (JSX) and Go showing good practices and integrations with modern tools. This project uses Bulma, Cypress, Docker, ESLint, gvt, make, Mock Service Worker, Rove, Storybook, Swagger, and Travis-CI.
https://github.com/josephspurrier/gomithrilapp

bulma cypress docker eslint golang jsx makefile mithril notepad-application storybook swagger travis-ci vscode

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/josephspurrier/gomithrilapp
Owner: josephspurrier
License: mit
Created: 2020-03-30T12:04:25.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-07T16:32:27.000Z (almost 2 years ago)
Last Synced: 2024-06-21T16:41:01.470Z (5 months ago)
Topics: bulma, cypress, docker, eslint, golang, jsx, makefile, mithril, notepad-application, storybook, swagger, travis-ci, vscode
Language: Go
Homepage: https://josephspurrier.github.io/gomithrilapp
Size: 31.5 MB
Stars: 9
Watchers: 3
Forks: 1
Open Issues: 37
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-mithril - gomithrilapp - Sample notepad application in Mithril (JSX) and Go showing good practices and integrations with modern tools using Bulma, Cypress, Docker, ESLint, gvt, make, Rove, Swagger, and Travis-CI. (Uncategorized / Uncategorized)

README

        # gomithrilapp

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

[![Build Status](https://travis-ci.org/josephspurrier/gomithrilapp.svg)](https://travis-ci.org/josephspurrier/gomithrilapp)

[![Coverage Status](https://coveralls.io/repos/github/josephspurrier/gomithrilapp/badge.svg?branch=master&timestamp=20200313-01)](https://coveralls.io/github/josephspurrier/gomithrilapp?branch=master)

[![Swagger Validator](https://online.swagger.io/validator?url=https://raw.githubusercontent.com/josephspurrier/gomithrilapp/master/src/app/ui/static/swagger.json)](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/josephspurrier/gomithrilapp/master/src/app/ui/static/swagger.json)

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](https://josephspurrier.github.io/gomithrilapp/) is generated using [Docusaurus](https://docusaurus.io/) and hosted using [GitHub Pages](https://pages.github.com/). This project uses a [Makefile](Makefile) to centralize frequently used commands. The code coverage badge above is only for the back-end API - not the front-end.

![Demo gif](https://user-images.githubusercontent.com/2394539/76177148-ac753e00-6189-11ea-963b-bff38b29e8ed.gif)

## Quick Start with Docker Compose

To test the application locally, you can follow these [instructions](https://josephspurrier.github.io/gomithrilapp/docs/tutorial/run-locally). 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.

- [Environment Preparation](https://josephspurrier.github.io/gomithrilapp/docs/tutorial/env-prep)

- [Database](https://josephspurrier.github.io/gomithrilapp/docs/database)

- [Front-End](https://josephspurrier.github.io/gomithrilapp/docs/front-end)

- [Back-End](https://josephspurrier.github.io/gomithrilapp/docs/back-end)

- [Swagger](https://josephspurrier.github.io/gomithrilapp/docs/swagger)

- [Docker Compose](https://josephspurrier.github.io/gomithrilapp/docs/docker-compose)

- [Documentation](https://josephspurrier.github.io/gomithrilapp/docs/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:

- [Vue and Go](https://github.com/josephspurrier/govueapp)

- [Mithril and Go](https://github.com/josephspurrier/gomithrilapp)

- [Mithril (TypeScript) and Go](https://github.com/josephspurrier/gomithriltsapp)

- [React (TypeScript) and Go](https://github.com/josephspurrier/goreactapp)