README
¶
gomithrilapp
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.
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:
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
app/api
Package api gomithrilapp API
|
Package api gomithrilapp API |
|
app/api/pkg/env
Package env will fill a struct from environment variables.
|
Package env will fill a struct from environment variables. |
|
app/api/pkg/logger
Package logger standardizes the logging functions available to your team.
|
Package logger standardizes the logging functions available to your team. |
|
app/api/pkg/mock
Package mock allows you to return specific values for functions.
|
Package mock allows you to return specific values for functions. |
|
app/api/pkg/passhash
Package passhash provides password hashing functionality using bcrypt.
|
Package passhash provides password hashing functionality using bcrypt. |