GithubHelp home page GithubHelp logo

aquilax / gobi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fern4lvarez/gobi

0.0 3.0 0.0 208 KB

Command line tool to make Go development faster and easier.

License: MIT License

Go 100.00%

gobi's Introduction

              _     _ 
             | |   (_)
   __ _  ___ | |__  _ 
  / _' |/ _ \| '_ \| |
 | (_| | (_) | |_) | |
  \__' |\___/|_.__/|_|
   __/ |              
  |___/

Build Status Documentation online

gobi is a command line tool that will make your Go development just faster. It might stand for Go Boilerplater Injector, but just think of it as a fun, tiny tool to create and manage quickly your applications written in Go.

gobi is on current development, so it's planned to get more features as long as time passes by. As of version 0.1.x these are the main current features:

  • Create command line applications ready to use.
  • Create Go packages with a basic test suite and example included.
  • Create a web application with Bootstrap assets and ready to deploy on most popular PaaS.
  • Two-level path projects.
  • Create your profile with your desired configuration.
  • LICENSE, README, VERSION, .gitignore and other files included out of the box.

Install (with GOPATH set on your machine)


  • Step 1: Get the package. Then you will be able to use gobi as an executable.
go get github.com/fern4lvarez/gobi
  • Step 2 (Optional): Run tests
$ go test -v .

##Usage

You'll have to introduce your configuration the first time you use gobi:

$ gobi
No configuration found! I'd like to know more about you. 
Name: // Your real name.
Username: // Your user name.
Host: // Host of your projects. Currently only github.com, bitbucket.org and code.google.com are supported.
Email: // Your email address.
License: The license applying to your projects. (Supporting AGPL, Apache, BSD, BSD3-Clause, Eclipse, GPLv2, GPLv3, LGPLv2.1, LGPLv3, MIT, Mozilla, PublicDomain, WTFPL and no-license)

A file called .gobi.json will be created on your $HOME directory containing all your configuration. If you want to restart your configuration, you have to remove this file and execute gobi again. Dynamic management of the configuration is planned to be implemented.

If you need help:

$ gobi help

If you want to know the current gobi version:

$ gobi version

If you want to know who you are (so what's your configuration):

$ gobi whoami

If you want to create a command line application:

$ gobi cl <APPNAME>

If you want to create a Go package:

$ gobi pkg <APPNAME>

If you want to create a web application:

$ gobi web <APPNAME>

In all cases <APPNAME> can have one or two levels and can't be empty. (Examples: regexp, fmt, net/http, crypto/md5)

##TODO

  • Better Tests (unit and functional tests)
  • Manage configuration (restart config, update fields, etc.)
  • Manage projects (delete, date created, date last modified, etc.)
  • go get projects after created
  • Git management (init, add and commit to new project's repo)
  • Fallback (undo everything when creation process fails)
  • Introduce CI on projects
  • Automatic update of gobi
  • Create files asynchronously using go routines
  • Lots of refactoring needed
  • Your suggestion HERE

##Contribute! You all are welcome to take a seat and make a contribution to this repo: reviews, issues, feature suggestions, possible code or functionality enhancements... Everything is appreciated!

##License gobi is MIT licensed, see here

gobi's People

Contributors

fern4lvarez avatar aquilax avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.