Skip to content

New project template to help bootstrap and streamline projects with pre-configured CI/CD, security tests, pre-commit, linting, docs, task runner, etc. Uses the python project "Copier"

License

Notifications You must be signed in to change notification settings

evanharmon1/harmon-stack

Repository files navigation

Harmon Stack

This repo allows you to create a new project using the Harmon Stack template which bootstraps numerous configurations and tools for you.

Author: Evan Harmon

Validate Security

Usage

Create a new project with: copier copy harmon-stack new-project --trust

The command will ask you a series of questions to create a new project. Before using for the first time you will probaby want to customize the copier.yml file. Most importantly, the variables that aren't presented to you when you create a project (i.e, the varables that are set to when: false).

Standard Procedure For New Projects

  1. From your git directory: copier copy harmon-stack new-project --trust, replacing new-project with the name of your new project.
  2. Initialize git repo?: Yes
  3. Create new repo on GitHub?: Yes
  4. Create initial release on GitHub?: Yes After initial questions, GitHub will ask questions about creating the repo on GitHub.
  5. Choose "Push an existing localy repository to GitHub" and choose the current path (.)

Setup & Installation

Requirements

Task Runner

Taskfile.yaml

Testing

Validate

task validate

Security

task security

Linting, Formatting, Conventions, Style Guidelines, etc

  • .pre-commit-config.yaml
  • .shellcheckrc
  • .ansible-lint-ignore

Todo File

todo.md

About

New project template to help bootstrap and streamline projects with pre-configured CI/CD, security tests, pre-commit, linting, docs, task runner, etc. Uses the python project "Copier"

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published