KICKOFF

 __   .__        __          _____  _____
|  | _|__| ____ |  | _______/ ____\/ ____\
|  |/ /  |/ ___\|  |/ /  _ \   __\\   __\
|    <|  \  \___|    <  <_> )  |   |  |
|__|_ \__|\___  >__|_ \____/|__|   |__|
     \/       \/     \/   Project Bootstrapping Tool

KICKOFF is a commandline tool for quick and easy project bootstrapping.

Have an amazing idea and want to dive straight into coding?

Setup your new project with one command!

Demo:

Install

go get -u github.com/dreadl0ck/kickoff

Usage

kickoff [template] <projectname>

Configuration

KICKOFF looks inside the $HOME/.kickoff directory for project templates when started.

Each subfolder and all its contents will serve as template and will simply be copied into a new directory with the desired project name.

If no template name was specified, the default folder will be used.

If you want to automatically initialize a git repository, just create an empty .git folder into your template.

Configuration Examples

A simple template directory could look like this:

user@host:~/.kickoff$ tree
.
├── default
│   ├── AUTHORS
│   ├── LICENSE
│   ├── Makefile
│   ├── README.md
│   └── TODO.md
├── go
│   ├── AUTHORS
│   ├── LICENSE
│   ├── Makefile
│   ├── README.md
│   ├── TODO.md
│   ├── main.go
│   └── zeus
│       ├── bench.sh
│       ├── build.sh
│       ├── clean.sh
│       ├── install.sh
│       ├── run.sh
│       └── test.sh
├── haskell
│   ├── AUTHORS
│   ├── LICENSE
│   ├── Makefile
│   ├── README.md
│   ├── TODO.md
│   └── main.hs
└── python
    ├── AUTHORS
    ├── LICENSE
    ├── Makefile
    ├── README.md
    ├── TODO.md
    └── main.py
5 directories, 29 files

What you see here are 4 template directories,
for the python, haskell and go programming languages and one for a default project.

Usage Examples

Usage is pretty straight forward.
Here’s a simple example for creating a new go project:

# bootstrap a new project named testProject
# use the go template
$ kickoff go testProject
...

Build System

KICKOFF uses ZEUS as its build system.
But you can also use the go tools for compilation / installation directly.

Project Stats

-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Go                               2             78             55            225
Markdown                         2             31              0            135
Bourne Shell                     4              8             12              9
-------------------------------------------------------------------------------
SUM:                             8            117             67            369
-------------------------------------------------------------------------------

License

KICKOFF - Project Bootstrapping Tool
Copyright (c) 2017 Philipp Mieden <dreadl0ck [at] protonmail [dot] ch>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses></http:>.

Contact

You have ideas, feedback, bugs, security issues, pull requests etc?

Contact me: dreadl0ck [at] protonmail [dot] ch