todoberry-server

command module
v0.0.0-...-9877464 Latest Latest
Warning

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

Go to latest
Published: Jun 28, 2019 License: MIT Imports: 4 Imported by: 0

README

TodoBerry Server

TodoBerry is an opensource list-making and issue tracking application.

NOTE!

This project is very early stages and is not yet usable as an application. However it is available for anyone to test, play with or contribute to.

This Repository belongs to TodoBerry's Server side application that serves our RESTFul API.

Getting Start

 $ go get -u github.com/TameshkCloud/todoberry-server

Make sure your redis server is running and configuration inside config/conf/redis.toml is up-to-date with your server configuration.

Start Development

We use Glide Package Manager to manage our project dependencies. Make sure Glide is installed on your system:

$ curl https://glide.sh/get | sh

Install dependencies:

$ glide up

Glide will install all dependencies listed in glide.yml file located in root directory of project. All this project vendors are patched version and stable.

Check out router/gin.go to follow-up code execution

Generating Swagger documentations

Install gin-swagger:

$ go get -u github.com/swaggo/swag/cmd/swag

and simply run:

$ swag init

now you can run go run main.go and check http://127.0.0.1:3000/swagger/index.html to see documentations generated automatically by swagger!

there is two additional health checker apis you can check them here:

Todos

  • MongoDB driver
  • JWT Authentication
  • Writing unit tests
  • etcd integration with Viper
  • command line tools using Cobra
  • Dependency Documents (English/Persian)

Contact Us

feel free to send your ideas in twitter for us: @rezaseyf2013

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
application

Jump to

Keyboard shortcuts

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