FilaKit

https://github.com/jeffersongoncalves/filakit
Admin
FilaKit is a starter kit built on Laravel and Filament designed to accelerate web application...
Tokens:1,680
Snippets:32
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run automated installation

Source: https://github.com/jeffersongoncalves/filakit/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
```

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

### Set up environment file (Docker)

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

Sets up the environment file for Docker installation.

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

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

### Install with FilaKit CLI

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

Alternative installation using the FilaKit CLI. Requires the CLI to be installed globally via `composer global require jeffersongoncalves/filakit-cli`.

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

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

### Run the development server

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

Starts the Laravel development server.

```bash
php artisan serve
```

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

### Create Laravel app with FilaKit

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

Creates a new Laravel application using the FilaKit starter kit with MySQL as the database. This is the primary installation method.

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

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

### Install Composer dependencies

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

Installs PHP Composer dependencies.

```bash
composer install
```

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

### Install JavaScript dependencies

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

Installs JavaScript dependencies using PNPM.

```bash
pnpm install
```

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

### Start Sail containers

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

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

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

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

### Configure custom ports for Docker

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

Example environment variables for customizing ports in the .env file when using Docker. 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
```

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

### Set up environment and generate key

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

Sets up the environment file and generates the application key.

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

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

### Move into project directory

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

Moves into the project directory.

```bash
cd my-app
```

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

### Build frontend assets

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

Builds frontend assets.

```bash
pnpm run build
```

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

### Run database migrations

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

Runs database migrations.

```bash
php artisan migrate
```

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

### Run development environment

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

Development commands: `composer dev` runs the full development environment (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
```

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

### Generate application key (Docker)

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

Generates the application key inside the Sail container.

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

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

### Attach to application container

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

Attaches to the application container to run commands inside it.

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