Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kdcio/init

Initialize KDC Projects with npm & git. Security included!
https://github.com/kdcio/init

boilerplate cli devops devsecops encrypt-files git git-secret git-secrets hacktoberfest kdc kdcio macos nodejs starter

Last synced: 1 day ago
JSON representation

Initialize KDC Projects with npm & git. Security included!

Host: GitHub
URL: https://github.com/kdcio/init
Owner: kdcio
License: mit
Created: 2020-10-16T23:30:32.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-01-06T15:24:12.000Z (over 1 year ago)
Last Synced: 2024-08-26T19:54:24.455Z (about 1 month ago)
Topics: boilerplate, cli, devops, devsecops, encrypt-files, git, git-secret, git-secrets, hacktoberfest, kdc, kdcio, macos, nodejs, starter
Language: JavaScript
Homepage:
Size: 1.22 MB
Stars: 1
Watchers: 4
Forks: 2
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # KDC Init

Initialize KDC Projects with npm & git. Security included!

[![ver](https://img.shields.io/npm/v/@kdcio/init)](https://www.npmjs.com/package/@kdcio/init) [![build](https://img.shields.io/github/workflow/status/kdcio/init/build)](https://github.com/kdcio/init/actions?query=workflow%3Abuild) [![size](https://img.shields.io/bundlephobia/min/@kdcio/init)](https://bundlephobia.com/result?p=@kdcio/init) [![Known Vulnerabilities](https://snyk.io/test/github/kdcio/init/badge.svg?targetFile=package.json)](https://snyk.io/test/github/kdcio/init?targetFile=package.json) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kdcio_init&metric=alert_status)](https://sonarcloud.io/dashboard?id=kdcio_init) [![license](https://img.shields.io/github/license/kdcio/init)](https://github.com/kdcio/init/blob/master/LICENSE)

## Features

0. Install [gpg](https://gnupg.org/) - Encrypt files using a public and a secret key identified by your email address.

1. Install [git-secrets](https://github.com/awslabs/git-secrets) - Prevents you from committing passwords and other sensitive information in plain text to a git repository.

2. Install [git-secret](https://git-secret.io/) - Encrypt files that containt passwords and other sensitive information before comitting to a git repository.

3. Run `git init` - Initialize git repository.

4. Run `npm init` - Initialize npm project.

5. Install husky and lint-staged - Enable git hooks to make use of [git-secrets](https://github.com/awslabs/git-secrets).

## Prerequisites

Please install the following before using:

- [brew](https://brew.sh/)

- [git](https://formulae.brew.sh/formula/git#default)

- [node, npm & npx](https://formulae.brew.sh/formula/node@12#default)

## Usage

```bash

npx @kdcio/init 

```

Visit [git-secret](https://git-secret.io/) to learn how to use it.