mirror of
https://github.com/sp-tarkov/forge.git
synced 2025-02-12 20:20:41 -05:00
Adds a light .env example
This commit is contained in:
parent
0e3783555e
commit
bd6011c77c
44
.env.light
Normal file
44
.env.light
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
APP_NAME="The Forge"
|
||||||
|
APP_ENV=local
|
||||||
|
|
||||||
|
# Generate a new key with: `php artisan key:generate`
|
||||||
|
APP_KEY=
|
||||||
|
|
||||||
|
APP_DEBUG=true
|
||||||
|
APP_TIMEZONE=UTC
|
||||||
|
APP_LOCALE=en
|
||||||
|
APP_FALLBACK_LOCALE=en
|
||||||
|
APP_FAKER_LOCALE=en_US
|
||||||
|
|
||||||
|
# Update to whatever you've configured your local web server to use.
|
||||||
|
APP_URL=http://forge.test
|
||||||
|
|
||||||
|
VITE_APP_NAME="${APP_NAME}"
|
||||||
|
|
||||||
|
# Much higher in production
|
||||||
|
BCRYPT_ROUNDS=4
|
||||||
|
|
||||||
|
LOG_CHANNEL=stack
|
||||||
|
LOG_STACK=single
|
||||||
|
LOG_DEPRECATIONS_CHANNEL=null
|
||||||
|
LOG_LEVEL=debug
|
||||||
|
|
||||||
|
# SQLite is being used here for simplicity, but will break functionality with
|
||||||
|
# the import job. Shouldn't matter for light development work. Must be absolute!
|
||||||
|
DB_CONNECTION=sqlite
|
||||||
|
DB_DATABASE=/Users/USER/Sites/forge/database/database.sqlite
|
||||||
|
|
||||||
|
FILESYSTEM_DISK=local
|
||||||
|
ASSET_URL="${APP_URL}/storage"
|
||||||
|
ASSET_URL_LIVEWIRE=/vendor/livewire/livewire.js
|
||||||
|
|
||||||
|
SESSION_DRIVER=file
|
||||||
|
BROADCAST_CONNECTION=log
|
||||||
|
CACHE_STORE=file
|
||||||
|
QUEUE_CONNECTION=sync
|
||||||
|
SCOUT_DRIVER=collection
|
||||||
|
|
||||||
|
# Mail will be written to the file log.
|
||||||
|
MAIL_MAILER=log
|
||||||
|
MAIL_FROM_ADDRESS="no-reply@sp-tarkov.com"
|
||||||
|
MAIL_FROM_NAME="${APP_NAME}"
|
21
.github/README.md
vendored
21
.github/README.md
vendored
@ -12,12 +12,7 @@ The Forge is a Laravel-based web application that provides a platform for the Si
|
|||||||
|
|
||||||
## Development Environment Setup
|
## Development Environment Setup
|
||||||
|
|
||||||
This is a [Laravel](https://laravel.com/docs/11.x) project that uses [Sail](https://laravel.com/docs/11.x/sail), which provides a Docker-based development environment. You can see detailed instructions on how to configure the development environment on the project wiki:
|
We use [Laravel Sail](https://laravel.com/docs/11.x/sail) to mirror the services that are used in our production server in a local development environment. You can see detailed instructions on how to configure the [full development environment](https://github.com/sp-tarkov/forge/wiki/Full-Windows-Dev-Env) or a [lightweight development environment](https://github.com/sp-tarkov/forge/wiki/Light-Windows-Dev-Env) on the project wiki. The full development environment is recommended.
|
||||||
https://github.com/sp-tarkov/forge/wiki/Dev-Environment-Setup,-Windows-11,-WSL2
|
|
||||||
|
|
||||||
### Accessing the Application:
|
|
||||||
|
|
||||||
Once the Docker containers are running with Sail you can access the application at <https://localhost>.
|
|
||||||
|
|
||||||
### Available Services:
|
### Available Services:
|
||||||
|
|
||||||
@ -38,7 +33,7 @@ Once the Docker containers are running with Sail you can access the application
|
|||||||
| Meilisearch WebUI | Local Only | <http://localhost:7700> |
|
| Meilisearch WebUI | Local Only | <http://localhost:7700> |
|
||||||
| Mailpit WebUI | Local Only | <http://localhost:8025> |
|
| Mailpit WebUI | Local Only | <http://localhost:8025> |
|
||||||
|
|
||||||
Most of these connection settings should already be configured in the `.env.example` file. Simply save the `.env.example` file as `.env` and adjust further settings as needed.
|
Most of these connection settings should already be configured in the `.env.full` or `.env.light` example files. Simply save one of these (depending on your environment) as `.env` and adjust settings as needed.
|
||||||
|
|
||||||
### Basic Usage Examples
|
### Basic Usage Examples
|
||||||
|
|
||||||
@ -46,32 +41,32 @@ Here are some basic commands to get started with Forge:
|
|||||||
|
|
||||||
```
|
```
|
||||||
# Start the Docker containers in detached mode:
|
# Start the Docker containers in detached mode:
|
||||||
./vendor/bin/sail up -d
|
sail up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
# View all of the available Artisan commands:
|
# View all of the available Artisan commands:
|
||||||
./vendor/bin/sail artisan
|
sail artisan
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
# Migrate and seed the database with test data:
|
# Migrate and seed the database with test data:
|
||||||
./vendor/bin/sail artisan migrate:fresh –seed
|
sail artisan migrate:fresh –seed
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
# Run Laravel Horizon (the queue workers/monitor):
|
# Run Laravel Horizon (the queue workers/monitor):
|
||||||
./vendor/bin/sail artisan horizon
|
sail artisan horizon
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
# Install NPM dependencies from within the container:
|
# Install NPM dependencies from within the container:
|
||||||
./vendor/bin/sail npm install
|
sail npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```
|
||||||
# Start the development server:
|
# Start the development server:
|
||||||
./vendor/bin/sail npm run dev
|
sail npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### More Information
|
### More Information
|
||||||
|
Loading…
x
Reference in New Issue
Block a user