Pandora

command module
v0.0.0-...-598afe9 Latest Latest
Warning

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

Go to latest
Published: Mar 12, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

README

Pandora

Pandora is a simple web service API implemented with golang.

Installation

go get github.com/Fallensouls/Pandora

How to use

Required
  • PostgreSQL
  • Redis
Configuration

You can use your own configuration to run Pandora. For example:

service:
  name: Pandora

server:
  run_mode: debug  # debug, release or test
  port: 8080
  read_timeout: 60  # 60s
  write_timeout: 60

database:
  type: postgres
  name: postgres
  user: postgres
  password: *******
  host: 127.0.0.1
  port: 5432

redis:
  host: 127.0.0.1
  port: 6379
  password: *******
  
jwt:
  signing_algorithm: HS256  # HS256, HS384 or HS512
  secret: *******
  timeout: 60               # 60min
  issuer: Fallensouls

Features

  • Restful API
  • JWT-based authentication
  • Yaml Configuration
  • OAuth
  • Swagger
  • Log
  • Docker
  • Pandora-pkg
    • CAPTCHA
    • Email
    • SMS
    • QR Code

Packages we use

Author

Fallensouls - I really love golang which changes my code style and thinking in programming. Hope that everyone could enjoy golang!

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package api provides all useful API for frontend.
Package api provides all useful API for frontend.
Package conf only accomplishes loading configuration.
Package conf only accomplishes loading configuration.
Package errs defines all possible errors may occur in runtime.
Package errs defines all possible errors may occur in runtime.
Package middleware includes all gin-style middleware.
Package middleware includes all gin-style middleware.
jwt
Package routers specifies routing for each API.
Package routers specifies routing for each API.
util

Jump to

Keyboard shortcuts

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