Download the PHP package cornell-custom-dev/laravel-starter-kit without Composer
On this page you can find all versions of the php package cornell-custom-dev/laravel-starter-kit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cornell-custom-dev/laravel-starter-kit
More information about cornell-custom-dev/laravel-starter-kit
Files in cornell-custom-dev/laravel-starter-kit
Package laravel-starter-kit
Short Description Cornell University Custom Development Laravel Starter Kit
License MIT
Informations about the package laravel-starter-kit
Laravel Starter Kit
A Cornell University CIT Custom Development starter kit and library for Laravel.
Goals
- Reduce time to build Laravel apps
- Increase consistency in configuration, third-party packages, and architecture
- Increase code visibility, code quality, and team collaboration
- Continuously improve code and practices
- Lower barriers for support and reduce support time
Usage
The Starter Kit can be used as a starter kit for a new site or as a library for an existing site.
As a Starter Kit for a New Site
Used as a starter kit, this package deploys the cwd_framework_lite infrastructure and standard configuration files. The steps below get from a fresh Laravel install to a working site.
-
Follow standard Laravel project creation, namely
This is done with the
--no-dev
option, because we will be committing the vendor dir and don't need that extra baggage.NOTE: If you have GitHub CLI installed, you can immediately add this to GitHub as a repo with the following commands (be sure to replace the "your-app-name" references with your project info):
-
Composer require the LaravelStarterKit
Similar to the
create-project
option, the--update-no-dev
keeps us from adding baggage to the vendor dir. -
Install the Starter Kit
The
starterkit:install
command prompts for a set of install options:- publish configured project files to the base directory and update the
composer.json
file to match - publish HTML/CSS/JS theme assets from cwd_framework_lite
- publish a set of view components that can be used to begin a layout
- publish example blade files to see usage of the layout
NOTE: The "project files" option updates
.gitignore
so that the vendor directory is no longer excluded. The next commit will be large because it includes everything in the vendor directory.
- publish configured project files to the base directory and update the
-
Testing the site
You can confirm the site is working with Lando, since the Starter Kit install process adds a.lando.yml
file.Then visit https://your-app-name.lndo.site and you should see the default Laravel page. To see the Laravel Starter Kit example page, edit
/resources/views/welcome.blade.php
to be:
As a Library for an Existing Site
For an existing Laravel site, this package can be composer-required to provide the library of classes and optionally install some components.
-
Composer require the LaravelStarterKit
-
Install the Starter Kit
Note: When using as a library or updating an installation, you will not want to install the project files. You may still want to install the theme assets, view components, and possibly example files. Be aware that these will overwrite existing files.
Libraries
The libraries included in the Starter Kit are documented in their respective README files:
- Contact/PhoneNumber: A library for parsing and formatting a phone number.
Deploying a site
Once a Media3 site has been created, you have confirmed you can reach the default site via a web browser, and you have access to the site login by command line, the code can be deployed.
You will likely need to map the php
command to the correct version by editing ~/.bashrc
to include this alias (for this to take effect, run source ~/.bashrc
or just log in again):
Since www/your-site/public
will already exist, you need to do a little moving things around to git clone your site repo from GitHub:
At this point you can configure the www/your-site/.env
file:
Be sure to set your APP_*
values to appropriate values, based on whether it is production:
If you visit your site now, you should see the Laravel site working.
Contributing
Anyone on the Custom Development team should be welcome and able to contribute. See CONTRIBUTING for details on how be involved and provide quality contributions.
All versions of laravel-starter-kit with dependencies
livewire/livewire Version ^3.3
spatie/laravel-package-tools Version ^1.16
cubear/cwd_framework_lite Version ^3.0
propaganistas/laravel-phone Version ^5.0