Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cjpatoilo/initify

Open Source Boilerplate – easy as cake!
https://github.com/cjpatoilo/initify

automation boilerplate cli license npm open-source starter-kit tooling tools

Last synced: 2 months ago
JSON representation

Open Source Boilerplate – easy as cake!

Host: GitHub
URL: https://github.com/cjpatoilo/initify
Owner: cjpatoilo
License: mit
Created: 2016-12-01T19:28:19.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2023-02-27T01:28:55.000Z (almost 2 years ago)
Last Synced: 2024-10-16T07:23:29.494Z (2 months ago)
Topics: automation, boilerplate, cli, license, npm, open-source, starter-kit, tooling, tools
Language: Roff
Homepage: https://cjpatoilo.com/initify
Size: 358 KB
Stars: 25
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: readme.md
- Contributing: .github/contributing.md
- Funding: .github/funding.yml
- License: license

Awesome Lists containing this project

README

        

> A meaningful Open Source Boilerplate – it's a piece of cake!

[![Travis Status](https://travis-ci.org/cjpatoilo/initify.svg?branch=master)](https://travis-ci.org/cjpatoilo/initify?branch=master)

[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/yd5ohn9syy91fk7l?svg=true)](https://ci.appveyor.com/project/cjpatoilo/initify)

[![Codacy Status](https://img.shields.io/codacy/grade/5009698540f040ec994a71fc84a4d675/master.svg)](https://www.codacy.com/app/cjpatoilo/initify/dashboard)

[![Dependencies Status](https://david-dm.org/cjpatoilo/initify/status.svg)](https://david-dm.org/cjpatoilo/initify)

[![Version Status](https://badge.fury.io/js/initify.svg)](https://www.npmjs.com/package/initify)

[![Download Status](https://img.shields.io/npm/dt/initify.svg)](https://www.npmjs.com/package/initify)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/initify)

## Why it's awesome

Starting an Open Source project with ease. Initify is a work-in-progress project by [CJ Patoilo](https://twitter.com/cjpatoilo) that brings essential information to build professional Open Source projects. Note that there is no cake recipe, there is no right or wrong way or the BEST way, but there are some basic recommendation:

- A **README** easy to read

- The option for an open source **license**

- Useful **.gitignore** files

- **Github Templates**

- **Continuous Integration** support

- **EditorConfig** available

...these and many more are available in Initify, so stay tuned. Hope you enjoy!

## Install

**Install with npm**

```sh

$ npm i -g initify

```

**Install with Yarn**

```sh

$ yarn global add initify

```

**Run with npx (without installing)**

```sh

$ npx initify

```

## Usage

```

	Usage:

		$ initify  []

	Options:

		-h, --help              Display help information

		-v, --version           Output Initify version

		-a, --author            Set author

		-e, --email             Set email

		-d, --description       Set description

		-l, --license           Get license

		-i, --ignore            Get .gitignore

		-c, --ci                Get continuous integration

		--no-license            Disallow license

		--no-ignore             Disallow .gitignore

		--no-ci                 Disallow continuous integration

		--no-template           Disallow Github templates

		--no-editor             Disallow .editorconfig

		--no-readme             Disallow readme.md

	Examples:

		$ initify my-app

		$ initify my-app --ignore macos,node,grunt,test

		$ initify my-app --license apache-2.0

	Default settings with no arguments:

		$ initify  --license mit --ignore node --ci travis,appveyor

```

## Contributing

Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/initify#contributing.md).

## License

Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://github.com/cjpatoilo/initify#license).