@kurohyou/k-init

K-scaffold Initializer

Runs basic project setup for K-scaffold based Roll20 character sheets

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Built With

• JS
  • Inquirer
  • handlebars

(back to top)

Getting Started

Prerequisites

While not required for this module to function, the folder structure that it creates will be mostly useless if you do not install the K-scaffold in the generated directory.

Installation

Install the script globally to have access to the CLI keyword k-init.

npm i -g @kurohyou/k-init

(back to top)

Usage

Once installed globally, simply use the k-init cli command to begin project initialization.

The initializer will create the following folder structure:

./
├─ build/
├─ source/
│ ├─ articles/
│ │ └─_settings.pug
│ ├─ javascript/
│ │ └─_index.pug
│ ├─ mixins/
│ │ └─_index.pug
│ ├─ rolltemplate/
│ │ └─_index.pug
│ ├─ scss/
│ │ ├─ sections/
│ │ │ └─_index.scss
│ │ ├─ components/
│ │ │ └─_index.scss
│ │ ├─ _index.scss
│ │ ├─ _general.scss
│ │ ├─ _variables.scss
│ │ ├─ _fonts.scss
│ │ ├─ _index.scss
│ ├─ sheet_name.pug
│ └─ sheet_name.scss
├─ k.config.mjs
├─ package.json
└─ jsconfig.json

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the mit License. See LICENSE.txt for more information.

(back to top)

Changelog

v2.3.1

• Update to 1.0.1 of i18nReplacer to fix error with overwriting existing data-i18n attributes

v2.3.0

• Added ability to translate existing projects

v2.2.0

• Added k.config.js sfc option use.

v2.1.5

• Removed last references to scss/fonts.scss from sfc templates

v2.1.4

• Fixed crash caused by incorrect sfc template reference

v2.1.3

• Removed extraneous pug lines

v2.1.2

• Fixed an error in the master pug template that removed the sheet state attribute required for tabs to function.

v2.1.1

• Support for the googleFont mixin.

v2.1.0

• Updated initializer to offer project setup for sfc based project or standard project

v2.0.1

• Removed erroneous old boilerplate content

v2.0.0

• Updated to support v2 K-scaffold

v1.1.1

• Fixed a problem with the generated package.json

v1.1.0

• Updated to support v1.1.x of the K-scaffold

Contact

Scott Casey - @kurohyoustudios - [e-mail]

Project Link: https://github.com/Kurohyou-Studios/K-scaffold-initializer

(back to top)

Acknowledgments

Riernar has been invaluable for improving the K-scaffold framework itself and this initializer would not be possible without the improvements that they suggested and/or provided to the K-scaffold itself.

This readme template adapted from the Best-README-Template by Othneil Drew. Readme generated by Genme! by Scott Casey.

(back to top)