go-archetype

README

go-archetype

Archetype is a project templating toolkit. An archetype is defined as an original pattern or model from which all other things of the same kind are made. Archetype is a system that provides a consistent means of generating projects of virtually any kind.

Using archetypes provides a great way to enable developers quickly in a way consistent with best practices employed by your project or organization. We use archetypes to try and get our users up and running as quickly as possible by providing a sample project while introducing new users to current best practices. In a matter of seconds, a new user can have a working project to use as a jumping board for their work.

Installation

go install github.com/continuul/go-archetype

Usage

Archetype is a project templating toolkit. An archetype is defined as an
original pattern or model from which all other things of the same kind are made.
Archetype is a system that provides a consistent means of generating projects of
virtually any kind.

Using archetypes provides a great way to enable developers quickly in a way
consistent with best practices employed by your project or organization.  We use
archetypes to try and get our users up and running as quickly as possible by providing a
sample project while introducing new users to current best practices. In a matter of
seconds, a new user can have a working project to use as a jumping board for their
work.

Usage:
  go-archetype [command]

Available Commands:
  generate    Generate a starter project from an archetype
  help        Help about any command
  list        List the available archetypes
  version     Print version information

Flags:
      --config string   config file (default is $HOME/.go-archetype.yaml)
  -h, --help            help for go-archetype
  -t, --toggle          Help message for toggle

Use "go-archetype [command] --help" for more information about a command.

Related Projects

None.

Help

Got a question? We got answers.

File a GitHub issue, or join our Slack Community.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "Continuul" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally continuul infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you!

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

License

About

Continuul Solutions maintains and funds this project.

Documentation

Overview

Copyright © 2020 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.