Copy some of the readme from the old zero project

OLD-README.md

@@ -0,0 +1,278 @@
+# Commit0 [POC]
+
+**NOTE** 🛑 This is a proof of concept application. Before you start using this
+tool please talk to the team in the `#product-commit0` slack channel so we can
+give you better instructions on how to get started.
+
+[![Build Status](https://travis-ci.org/commitdev/commit0.svg)](https://travis-ci.org/commitdev/commit0)
+[![Go Report Card](https://goreportcard.com/badge/github.com/commitdev/commit0?style=flat-square)](https://goreportcard.com/report/github.com/commitdev/commit0)
+[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/commitdev/commit0)
+
+Status: Proof of Concept
+
+## About Commit0
+Commit0 is a project skaffolding framework and ecosystem created to:
+
+1. Maximize knowledge sharing across an organization 
+2. Easily maintain a state of the art and easily reusable implementations of production grade solutions to recurring problems
+3. Re-create the seamless deployment experience offered by PaaS solutions but with a fully open source stack that follows industry best practices
+
+With Commit0:
+- Easily deploy and integrate various boilerplate solutions
+- Instantly integrate commonly used open source microservices for authentication, user management, file encryption, image resizing etc. 
+- Get a simple Push-To-Deploy workflow that you are accustomed to with popular PaaS solutions [TODO]
+- There's no vendor lock-in. It's all implemented with open source tools and deployed to your own cloud provider.
+
+## Commit0 Generator CLI 
+Commit0 CLI is an opinionated, yet fully modular code generation tool with declarative syntax that allows developers to easily integrate user prompts and interactions. 
+
+Problems we encountered: 
+- It was tedious to create reusable templates and hard to maintain
+- Lack of standardization and integration interface between the templates
+- Difficult to integrate individually templated codebases
+
+How we aim to address those issues: 
+- Make templating behaviour simple and declarative
+- Clear strategy and guideline around what are clear and reusable templates
+- Standardize how templated code should get dependent parameters and start up
+
+This is inspired by: 
+- [Yeoman Generator](https://github.com/yeoman/generator)
+- [JHipster](https://github.com/jhipster/generator-jhipster)
+- [Boilr](https://github.com/tmrts/boilr)
+
+
+## Installation
+
+As there some dependencies it will be easier to use this tool within the provided image, clone the repo and then run `make build-docker-local`.
+The best way then to use this is to add an alias, then you can use the CLI as if it was installed as usual on your machine:
+`alias commit0='docker run -it -v "$(pwd):/project" -v "${HOME}/.aws:/root/.aws" commit0:v0'`
+
+# Usage
+
+1) To create a project run `commit0 create [PROJECT_NAME]`
+2) It will prompt you to select a cloud provider and an account profile to use
+3) A folder `PROJECT_NAME` will be created. You can `cd [PROJECT_NAME]` and configure the example `commit0.yml` that's generated
+4) Run `commit0 generate -c <commit0.yml>` to generate all the all the project repos
+5) You can go to each project repo and follow the project readme to start the service
+6) `commit0 ui` launches the locally hosted web UI (Static SPA) and the API server
+
+
+## Configuring Commit0
+
+This is a guide on how to configure your project manually with a single file `commit0.yml`. Simply write this file to the root of your project directory and run the commit0 CLI tool against it to generate your project files.
+
+*  [commit0.yml](#commit0-yaml)
+	*  [name*](#name)
+	*  [context](#context)
+	*  [modules*](#modules)
+		* [source*](#module-source)
+		* [params*](#module-params)
+		* [output](#module-output)
+    * [overwrite](#module-overwrite)
+*  [commit0.module.yml](#commit0-module-yaml)
+	*  [name*](#module-name)
+	*  [description](#module-description)
+	*  [prompts](#module-prompts)
+		*  [field*](#prompt-field)
+		*  [label](#prompt-label)
+		*  [options](#prompt-options)
+	*  [template](#template)
+		*  [extension](#template-extension)
+		*  [delimiters](#template-delimiters)
+		*  [output](#template-output)
+
+## Commit0.yaml<a name="commit0-yaml"></a>
+Your project config file. It describes the project 
+Example:
+```
+name: newProject
+context: 
+  cognitoPoolID: xxx
+modules: 
+  - source: "github.com/commitdev/commit0-aws-eks-stack"	
+    output: "infrastructure"
+  - source: "github.com/zthomas/react-mui-kit"	
+    output: "web-app"
+``` 
+
+## Name<a name="name"></a>
+Name of your project. This will be used to name the github repos as well as in other parts of the generated code.
+
+[]() | |
+--- | ---
+Required | True
+Type | String
+
+## Context<a name="context"></a>
+A key value map of global context parameters to use in the templates. 
+
+[]() | |
+--- | ---
+Required | False
+Type | Map[String]
+
+## Modules<a name="modules"></a>
+List of modules template modules to import
+
+[]() | |
+--- | ---
+Required | True
+Type | Map[Module]
+
+## Source<a name="module-source"></a>
+We are using go-getter to parse the sources, we you can use any URL or file formats that [go-getter](https://github.com/hashicorp/go-getter#url-format) supports.
+
+[]() | |
+--- | ---
+Required | True
+Type | String
+
+## Params<a name="module-params"></a>
+Module parameters to use during templating
+
+[]() | |
+--- | ---
+Required | True
+Type | String
+
+## Output<a name="module-output"></a>
+Template output directory that the current module should write to.
+
+[]() | |
+--- | ---
+Required | False
+Type | String
+
+## Overwrite<a name="module-overwrite"></a>
+Whether to overwrite existing files when generating files from templates
+
+[]() | |
+--- | ---
+Required | False
+Type | Boolean
+Default | False
+
+
+## Commit0.module.yaml<a name="commit0-module-yaml"></a>
+The module config file. You can configure how the templating engine should process the files in the current repository.
+Example:
+```
+name: react-mui-kit
+template: 
+  extension: '.tmplt'
+  delimiters: 
+    - '<%'
+    - '%>'
+  output: web-app
+``` 
+
+## Name<a name="module-name"></a>
+Name of your module. This will be used as the default module directory as well as a display name in the prompts.
+
+[]() | |
+--- | ---
+Required | True
+Type | String
+
+## Description<a name="module-description"></a>
+Short description of the module
+
+[]() | |
+--- | ---
+Required | False
+Type | String
+
+## template<a name="template"></a>
+Template configurations
+[]() | |
+--- | ---
+Required | False
+Type | Map
+
+## Extension<a name="template-extension"></a>
+File extension to signify that a file is a template. If this is defined, non-template files will not be parsed and will be copied over directly. The default value is `.tmplt`
+
+[]() | |
+--- | ---
+Required | False
+Type | Map
+
+## Delimiters<a name="template-delimiters"></a>
+An pair of delimiters that the template engine should use. The default values are: `{{`, `}}`
+
+[]() | |
+--- | ---
+Required | False
+Type | Map[String]
+
+## Output<a name="template-output"></a>
+The default template output directory that you want the template engine to write to. This will be overwritten by the 
+
+[]() | |
+--- | ---
+Required | False
+Type | String
+
+## Prompts<a name="prompts"></a>
+User prompts to generate to collect additional module specific params
+[]() | |
+--- | ---
+Required | False
+Type | Map
+
+## Field<a name="prompt-field"></a>
+The name of the field that the param should be written to
+
+[]() | |
+--- | ---
+Required | True
+Type | String
+
+## Label<a name="prompt-label"></a>
+The message that will be presented to the user
+
+[]() | |
+--- | ---
+Required | False
+Type | String
+
+## Options<a name="prompt-options"></a>
+A list of options to select from. If not given, then it will be rendered as a text input prompt.
+
+[]() | |
+--- | ---
+Required | False
+Type | Map[String]
+
+# Development
+We are looking for contributors!
+
+Building from the source
+```
+make install-go
+```
+Compile a new `commit0` binary in the working directory
+```
+make build
+```
+
+Now you can either add your project directory to your path or just execute it directly
+```
+mkdir tmp
+cd tmp
+../commit0 create test-app
+cd test-app
+../../commit0 generate -c commit0.yml
+```
+
+To run a single test for development
+```
+go test -run TestGenerateModules "github.com/commitdev/commit0/internal/generate" -v
+```
+
+### Building locally
+As there are some dependencies it will be easier to use this tool within the provided image, clone the repo and then run `make build-docker-local`.
+
+The best way then to use this is to add an alias, then you can use the CLI as if it was installed as usual on your machine:
+`alias commit0='docker run -it -v "$(pwd):/project" commit0:v0'`