TeamKit

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

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

Manual installation steps: install JavaScript and PHP dependencies, set up the environment file and generate an application key, 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/teamkitv5/blob/main/README.md

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

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

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

### Run the automated installation script

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

Runs the automated installation script that handles Composer dependencies, environment setup, database migrations, asset building, and Herd configuration.

```bash
php install.php
```

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

### Install JavaScript dependencies

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

Installs JavaScript dependencies using pnpm.

```bash
pnpm install
```

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

### Run development server

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

Commands to start the development environment. The first command runs all components together, while the second set runs them individually.

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

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

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

### Create a new project using FilaKit CLI

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

Uses the FilaKit CLI to create a new project with the TeamKit kit. Requires FilaKit CLI to be installed globally via composer.

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

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

### Install Composer dependencies

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

Installs PHP dependencies required by the Laravel application.

```bash
composer install
```

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

### Start Sail containers

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

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

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

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

### Navigate to project directory

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

Moves into the project directory after cloning or creating the application.

```bash
cd my-app
```

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

### Create a new Laravel project with TeamKit

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

Creates a new Laravel application using the TeamKit starter kit with MySQL as the database.

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

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

### Generate application key

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

Generates the application encryption key, typically run after setting up the environment.

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

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

### Configure custom ports in .env

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

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

### Apply tenant scope to a model

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

Apply a global scope to a model to filter queries by the current tenant. Uncomment and adapt the model name and query logic as needed.

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

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

### Attach to application container

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

Attaches to the application container to run commands inside the Sail environment.

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