2leonardo/hephaestus

Starter configuration files for projects

Installs: 17

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:TypeScript

Type:project

1.1.0 2023-08-02 13:14 UTC

This package is auto-updated.

Last update: 2025-05-29 01:48:14 UTC


README

This repository serves as a scaffolding template for projects that require the following common configuration files and folders:

  • .husky/: Husky configuration folder.
  • .vscode/: Visual Studio Code configuration folder.
  • .browserlistrc: Browserslist configuration file.
  • .deployignore: Deploy ignore file.
  • .editorconfig: EditorConfig file.
  • .eslintrc.json: ESLint configuration file.
  • .gitignore: Gitignore file.
  • .prettierrc: Prettier configuration file.
  • .stylelintignore: Stylelint ignore file.
  • .stylelintrc.json: Stylelint configuration file.
  • babel.config.json: Babel configuration file.
  • commitlint.config.cts: Commitlint configuration file.
  • composer.json: Composer configuration file.
  • package.json: Node.js package configuration file.
  • README.md: This readme file.

Usage

To use this project scaffolding as a starting point for your own project, you can follow these steps:

  1. Clone this repository:

    • Using git
    git clone https://github.com/2leonardo/hephaestus.git
    cd hephaestus
    • Using composer
    composer create-project 2leonardo/hephaestus
  2. Customize the configuration files and folders based on your project requirements.

  3. Start building your project on top of this scaffolding.

License

This project is licensed under the MIT License.

Feel free to use, modify, and distribute this scaffolding template as needed. If you find it useful, a link back to this repository would be appreciated but is not required.

Contribution

If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.

Happy coding! ⚡