README

This is a Laravel custom starter kit for FCS projects, including the Cornell Design System and FluxPro component libraries.

Local credentials

Add FluxPro and GitHub credentials to your home directory ~/.composer/auth.json, which will get mapped into the environment so you can access private repositories:

{
    "http-basic": {
        "composer.fluxui.dev": {
            "username": "YOUR_FLUXPRO_EMAIL",
            "password": "YOUR_FLUXPRO_LICENSE_KEY"
        }
    },
    "github-oauth": {
        "github.com": "YOUR_GITHUB_TOKEN"
    }
}

Create a new project

IMPORTANT

After running the Laravel installer, You need to replace .env.example with .env.example.stub because the Laravel installer overwrites it.

The initial install step will set the project name in composer.json, .lando.yml, .env.example.stub, and the README.md. If you need it to be different, edit those files after running laravel new ....

Follow the steps below, replacing "your-project-name":

laravel new your-project-name --using=cornell-custom-dev/fcs-laravel-base

cd your-project-name
mv .env.example.stub .env.example && cp .env.example .env
lando start

lando start will run the initial database migration.

GitHub setup

After running the installer, .gitignore will be configured so you can commit the composer.lock, package-lock.json, and vendor directory. Some helpful commands for doing that, after running lando start:

git init
git add .
git commit -m "Initial commit"

To create a new GitHub repository with the GitHub CLI based on the new project:

gh repo create CornellCustomDev/your-project-name --private --source=. --remote=origin --push

Daily use

lando artisan <command>
lando composer <command>

Layout and components

Layout: resources/views/components/layouts/app.blade.php — CDS docs
Components: ./resources/views/components/cds — FluxPro docs

Using components

Components are used in blade files with the <x-cds syntax. For example, to use the text input forms component, you would write:

<x-cds.forms.input
    name="email"
    label="Email"
/>

You can also pass additional attributes to the component and they will be applied to the contained input element ("required" in this case). Named slots can also be used to fill attributes. For example:

<x-cds.forms.input name="name" label="Name" required>
    <x-slot:description>
        Please enter your full name.
    </x-slot:description>
</x-cds.forms.input>

Common and defaulted attributes can be found in the component's blade file, generally as @prop definitions so that an IDE can provide autocomplete.

Flux component documentation should be consulted for additional options and usage.

cornell-custom-dev / fcs-laravel-base

Maintainers

Package info

Statistics

Security