poem

package module
v0.5.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2022 License: BSD-3-Clause Imports: 1 Imported by: 0

README

poem

Go-powered CMS for poets and writers (based on gRPC services)

Go Reference

Poem

This project is based on Go and use gRPC framework for backend web services. By developing this project, I learned:

  1. How to create gRPC services using Go and protoc (Protocol Buffer Compiler). Go to source code
  2. How to write Go tests. Go to source code
  3. How to create CLI subcommands. Go to source code
  4. How to create generic function to handle multiple types. Sql ExecDB generic function Sql QueryRowDB generic function Sql QueryDB generic function Template generic function

Test coverage:

webimizer.dev/poem/runtime 0.004s coverage: 100.0% of statements

webimizer.dev/poem/cmd/subcommands/install 4.481s coverage: 55.2% of statements

Build application:

make

Test application:

make test

Install on Docker:

  1. Build image from Dockerfile:
docker build . -t poem
  1. Copy file docker-compose.example.yml to docker-compose.yml and change environment variables (if needed).
cp docker-compose.example.yml docker-compose.yml
  1. Build Docker containers with docker-compose:
 docker-compose up -d
  1. Install CMS database with:
docker-compose exec poems_rpc /go/poem install

Documentation

Overview

Poem CMS main package

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func InitApplication

func InitApplication()

Initialize Poem CLI application

Types

This section is empty.

Directories

Path Synopsis
cmd
main
Main application package with main function (entrypoint)
Main application package with main function (entrypoint)
subcommands
Package for CLI subcommands registration
Package for CLI subcommands registration
subcommands/adminfrontend
admin frontend subcommand
admin frontend subcommand
subcommands/adminserver
admin server subcommand
admin server subcommand
subcommands/install
CMS install subcommand
CMS install subcommand
subcommands/oauthserver
oauth server subcommand
oauth server subcommand
subcommands/poemsserver
poems server subcommand
poems server subcommand

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL