drakiaxyz / forge

The greatest resource available for Single Player Tarkov modifications. Where modding legends are made. Discover powerful tools, expert-written guides, and exclusive mods.

The Forge

The Forge is a Laravel-based web application that provides a platform for the Single Player Tarkov community to share and discover user-generated content, such as mods, guides, and other tools. It is currently under heavy development. Please review this entire document before attempting to contribute, especially the "Development Discussion" section.

Development Environment Setup

This is a Laravel project that uses Sail, which provides a Docker-based development environment. Ensure you review the Sail documentation for useage, particularly in a Windows environment, as WSL2 is recommended.

Accessing the Application:

Once the Docker containers are running with Sail you can access the application at https://localhost.

Available Services:

Service	Access Via Application	Access Via Host
MySQL	mysql:3306	localhost:3306
Redis	redis:6379	localhost:6379
Meilisearch	meilisearch:7700	localhost:7700
Mailpit	mailpit:1025	localhost:8025

Notable Routes

Service	Authentication	Access Via Host
Administration Panel (Nova*)	Via User Role	https://localhost/nova
Redis Queue Management (Horizon)	Via User Role	https://localhost/horizon
Website Status (Pulse)	Via User Role	https://localhost/pulse
Meilisearch WebUI	Local Only	http://localhost:7700
Mailpit WebUI	Local Only	http://localhost:8025

^{*Nova may be replaced shortly due to License issues.}

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.

Basic Usage Examples

Here are some basic commands to get started with Forge:

# Start the Docker containers in detached mode:
./vendor/bin/sail up -d

# View all of the available Artisan commands:
./vendor/bin/sail artisan

# Migrate and seed the database with test data:
./vendor/bin/sail artisan migrate:fresh –seed

# Run Laravel Horizon (the queue workers/monitor):
./vendor/bin/sail artisan horizon

# Install NPM dependencies from within the container:
./vendor/bin/sail npm install

# Start the development server:
./vendor/bin/sail npm run dev

More Information

For more information on Laravel development, please refer to the official documentation.

Development Discussion

Please note, we are very early in development and will likely not accept work that is not discussed beforehand through the following channels...

You may propose new features or improvements of existing Forge behavior in the repository's GitHub discussion board. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.

Informal discussion regarding bugs, new features, and implementation of existing features takes place in the #website-general channel of the Single Player Tarkov Discord server. Refringe, the maintainer of Forge, is typically present in the channel on weekdays from 9am-5pm Eastern Time (ET), and sporadically present in the channel at other times.

Which Branch?

The main branch is the default branch for Forge. This branch is used for the latest stable release of the site. The develop branch is used for the latest development changes. All feature branches should be based on the develop branch. All pull requests should target the develop branch.

Coding Style

Forge follows the PSR-2 coding standard and the PSR-4 autoloading standard. We use an automated Laravel Pint action to enforce the coding standard, though it's suggested to run your code changes through Pint before contributing. This can be done by configuring your IDE to format with Pint on save, or manually by running the following command:

./vendor/bin/sail pint

Security Vulnerabilities

If you discover a security vulnerability within Forge, please email Refringe at [email protected]. All security vulnerabilities will be promptly addressed.

Code of Conduct

The Forge development code of conduct is derived from the Ruby code of conduct. Any violations of the code of conduct may be reported to Refringe at [email protected].

• Participants will be tolerant of opposing views.
• Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
• When interpreting the words and actions of others, participants should always assume good intentions.
• Behavior that can be reasonably considered harassment will not be tolerated.