FilaKit

https://github.com/jeffersongoncalves/filakitv4
Admin
FilaKit is a starter kit built on Laravel and Filament designed to accelerate the development of...
Tokens:2,269
Snippets:37
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Manual installation steps for FilaKit

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Manual installation steps: install JavaScript and Composer dependencies, set up the environment file and generate the app key, configure the database in .env, run migrations, build frontend assets, and start the development server.

```bash
pnpm install
```

```bash
composer install
```

```bash
cp .env.example .env
php artisan key:generate
```

```bash
php artisan migrate
```

```bash
pnpm run build
```

```bash
php artisan serve
```

--------------------------------

### Set up environment file

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Copies the example environment file to create the .env configuration.

```bash
cp .env.example .env
```

--------------------------------

### Run automated FilaKit installation

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Runs the automated installation script that installs Composer dependencies, sets up the environment, generates the app key, configures the database, runs migrations, installs Node dependencies, builds assets, and configures Herd if used.

```bash
php install.php
```

--------------------------------

### Scaffold a new app with FilaKit CLI

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Uses the FilaKit CLI to scaffold a new project with the FilaKit starter kit. Requires the CLI to be installed globally via Composer.

```bash
filakit new my-app --kit=jeffersongoncalves/filakitv4
```

--------------------------------

### Install Composer dependencies

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Installs Composer dependencies for the project.

```bash
composer install
```

--------------------------------

### Install JavaScript dependencies

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Installs JavaScript dependencies using pnpm.

```bash
pnpm install
```

--------------------------------

### Run development server and queues

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Development commands: `composer dev` runs the full development setup (server, logs, queues, asset compilation). Alternatively, run each component separately with `php artisan serve`, `php artisan queue:listen --tries=1`, and `pnpm run dev`.

```bash
# Run the development server with logs, queues and asset compilation
composer dev

# Or run each component separately
php artisan serve
php artisan queue:listen --tries=1
pnpm run dev
```

--------------------------------

### Start Sail containers

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Starts the Laravel Sail containers in detached mode. The development server is handled automatically, so `php artisan serve` is not needed.

```bash
./vendor/bin/sail up -d
```

--------------------------------

### Navigate to project directory

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Moves into the project directory after cloning.

```bash
cd my-app
```

--------------------------------

### Create a new Laravel app with FilaKit

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Creates a new Laravel application using the FilaKit starter kit with MySQL as the database. Requires PHP 8.3+, Composer, Node.js, and PNPM.

```bash
laravel new my-app --using=jeffersongoncalves/filakitv4 --database=mysql
```

--------------------------------

### Configure custom ports in .env

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Environment variables to configure custom ports for the application, MySQL, Redis, and Mailpit. Adjust these if other services are using the default ports.

```bash
# Application Port (ex: 8080)
APP_PORT=8080

# MySQL Port (ex: 3306)
FORWARD_DB_PORT=3306

# Redis Port (ex: 6379)
FORWARD_REDIS_PORT=6379

# Mailpit Port (ex: 1025)
FORWARD_MAILPIT_PORT=1025
```

--------------------------------

### Generate application key

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Generates the application encryption key.

```bash
php artisan key:generate
```

--------------------------------

### Attach to application container

Source: https://github.com/jeffersongoncalves/filakitv4/blob/main/README.md

Attaches to the application container to run commands inside it.

```bash
./vendor/bin/sail shell
```
Tokens:
Raw