emedia/oxygen-installer

There is no license information available for the latest version (v2.2.0) of this package.

Oxygen application installer.

v2.2.0 2023-03-26 23:16 UTC

This package is auto-updated.

Last update: 2024-11-27 02:54:30 UTC


README

Oxygen installer simply downloads the latest version of Laravel and automatically installs oxygen and sets it up as an oxygen project for you.

Version Compatibility

Oxygen VersionPackage VersionBranch
v7 / Laravel v102.2master
v6 / Laravel v92.1master
v5 / Laravel v82.0master
v4 / Laravel v71.xversion/v1.x

See change log for change history and compatibility with past versions.

Getting Started

Installation

  • To get started, first download the Oxygen Installer using Composer.
  • If you already have it installed, run it again to update the version. The latest version is 2.2.0
composer global require emedia/oxygen-installer

Make sure to place Composer's system-wide vendor bin directory in your $PATH so the executables can be located by your system. This directory exists in different locations based on your operating system; however, some common locations include:

macOS: $HOME/.composer/vendor/bin
Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin
GNU / Linux Distributions: $HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin

You could also find the composer's global installation path by running composer global about and looking up from the first line.

After a successful installation, you should get the latest version number by running oxygen -v.

How to Use

Once installed, the oxygen new command will create a fresh Laravel + Oxygen installation in the directory you specify. For instance, oxygen new blog will create a directory named blog containing a fresh Laravel + Oxygen installation with all dependencies already installed:

To create a new Oxygen project, run

oxygen new myproject

You can also pass the common parameters with just one line and go for a coffee, while it does the complete setup.

oxygen new myproject --name 'My Project' --dev_url 'localhost.test' --dbname mydatabase --dbuser john --dbpass mypassword --mailuser smtp_username --mailpass smtp_password

Change Oxygen/Laravel Version

By default, it will install the current version. You can switch the version if required.

// Install Laravel 10 + Oxygen 7 (default)
oxygen new myproject

// Install Laravel 9 + Oxygen 6
oxygen new myproject --o_version 6

// Install Laravel 8 + Oxygen 5
oxygen new myproject --o_version 5

// Install Laravel 7 + Oxygen 4
oxygen new myproject --o_version 4

// Install dev branch
oxygen new project --o_version dev

Available Options

The following options are available with the installer. All flags are optional, so you can set one or many.

CLI OptionWhat it Does
--o_versionTarget version of Oxygen (4 to 7 or 'dev')
--nameName of the project
--emailAdmin user's email address (to seed the database)
--dev_urlVirtualHost's APP_URL
--forceForces install even if the directory already exists
--dbhostDB Host
--dbportDB Port
--dbnameDB Name
--dbuserDB User
--dbpassDB Pass
--mailhostMail Host
--mailportMail Port
--mailuserMail Username
--mailpassMail Password
--no-npmDon't install NPM packages

Contributing and Developer Instructions

Please see CONTRIBUTING and for details.

Copyright

Copyright (c) 2023 Elegant Media.