@vidavidorra/create-project

Interactively create a GitHub project


Keywords
create, project
License
CNRI-Python-GPL-Compatible
Install
npm install @vidavidorra/create-project@2.0.86

Documentation

Create project

Interactively create a project.

  • Standardised project and repository setup.
  • Code style using XO.
  • Code formatting using Prettier.
  • Commit style using commitlint.
  • Version management using semantic-release.
  • Dependency management using Renovate.
  • Add TypeScript, a testing framework and code coverage as desired.

npm version npm downloads Node.js version support Renovate enabled semantic-release Code coverage License

Install

npm install --global @vidavidorra/create-project

Usage

Start the interactive CLI to create a project.

create-project

Or run the interactive CLI directly via npx.

npx @vidavidorra/create-project

Contributing

Please create an issue if you have a bug report or feature proposal, or create a discussion if you have a question. If you like this project, please consider giving it a star ⭐

Refer to the contributing guide for detailed information about other contributions, like pull requests.

Conventional Commits: 1.0.0 XO code style Code style

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2023-2024 Jeroen de Bruijn

License notice

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online.