TeamKit

https://github.com/jeffersongoncalves/teamkitv4
Admin
TeamKit is a starter kit built on Laravel and Filament designed to accelerate web application...
Tokens:3,458
Snippets:48
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Manual installation steps

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

Manual installation steps: install JavaScript dependencies, install Composer dependencies, set up environment and generate key, configure database in .env, run migrations, build frontend assets, and run the 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
```

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

### Run automated installation script

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

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

```bash
php install.php
```

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

### Set up environment file

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

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

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

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

### Install TeamKit using FilaKit CLI

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

Alternative installation using FilaKit CLI. Requires installing FilaKit CLI globally with `composer global require jeffersongoncalves/filakit-cli`.

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

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

### Install Composer dependencies

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

Installs Composer dependencies for the project.

```bash
composer install
```

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

### Install JavaScript dependencies

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

Installs JavaScript dependencies using pnpm.

```bash
pnpm install
```

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

### Start Sail containers

Source: https://github.com/jeffersongoncalves/teamkitv4/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/teamkitv4/blob/main/README.md

Moves into the project directory created by the previous command.

```bash
cd my-app
```

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

### Run development server with composer dev or individual commands

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

Run the development server with logs, queues, and asset compilation using the composer dev command, or run each component separately with php artisan serve, php artisan queue:listen --tries=1, and pnpm run dev.

```bash
composer dev
```

```bash
php artisan serve
php artisan queue:listen --tries=1
pnpm run dev
```

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

### Create a new Laravel app with TeamKit

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

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

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

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

### Configure custom ports in .env

Source: https://github.com/jeffersongoncalves/teamkitv4/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/teamkitv4/blob/main/README.md

Generates the application encryption key.

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

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

### Create storage link for avatar storage

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

Create the storage link required for avatar storage in the Filament Edit Profile plugin. Ensure the filesystem disk is configured and the storage link exists.

```bash
php artisan storage:link
```

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

### Attach to application container

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

Attaches to the application container to run commands inside it.

```bash
./vendor/bin/sail shell
```

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

### Apply tenant scope to a model

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

Apply a global scope to a model so queries are automatically filtered by the current tenant. Uncomment and adapt the model name and closure to your needs.

```php
// Example (uncomment and adapt):
// SomeModel::addGlobalScope(
//    fn (Builder $query) => $query->whereBelongsTo(Filament::getTenant()),
// );
```
Tokens:
Raw