About Create H3ravel

Scaffold a new H3ravel applications using kits and starter kits.

Starter kits

You can use between one of the following official starter kits, or bring your own using the --kit flag.

• full : A full H3ravel application with everything possible.
• lean : A lean H3ravel application with just the framework core.
• api : Creates a H3ravel application for building JSON APIs.
• web: Creates a H3ravel application for building a server rendered app.
• inertia: Inertia application with a frontend framework of your choice.

Usage

# Using npm
npm init h3ravel

# Using yarn
yarn create h3ravel

# Using pnpm
pnpm create h3ravel

Options

location

You can pass the installation location directory as the first argument to the command. For example:

npm init h3ravel my-app

or even

npm init h3ravel ./

This argument is optional and the command will prompt you to enter the installation location if not provided.

Note - The location must be empty or the command will fail.

--kit | -k (Default: Prompts for selection)

You can also use your own starter kit hosted on Github, Gitlab, or Bitbucket, use the --kit flag to define the repo URL.

# Download from GitHub
npm init h3ravel -- --kit="github:github_user/repo"

# Github is the default provider, so if not specified, it will be assumed as github
npm init h3ravel -- --kit="github_user/repo"

# Download from GitLab
npm init h3ravel -- --kit="gitlab:user/repo"

# Download from BitBucket
npm init h3ravel -- --kit="bitbucket:user/repo"

You can also pass the branch or tag name as follows:

# Branch name
npm init h3ravel -- --kit="github:github_user/repo#branch-name"

# Tag name
npm init h3ravel -- --kit="github:github_user/repo#v1.0.0"

--token | -t

If you are using a custom starter kit hosted on a private repository, then you can pass the authentication token with the --token options:

npm init h3ravel -- --kit="github:github_user/repo" --token="github_token"

Contributing

Thank you for considering contributing to the H3ravel framework! The Contribution Guide can be found in the H3ravel documentation and will provide you with all the information you need to get started.

Code of Conduct

In order to ensure that the H3ravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within H3ravel, please send an e-mail to Legacy via hamzas.legacy@toneflix.ng. All security vulnerabilities will be promptly addressed.

License

The H3ravel framework and all it's base packages are open-sourced software licensed under the MIT license.