Skip to content

Latest commit

 

History

History
208 lines (99 loc) · 4.44 KB

README_FR.md

File metadata and controls

208 lines (99 loc) · 4.44 KB

Necromunda Campaign Tracker

PHP Version Symfony Easy admin
Necromunda Logo

Introduction

Necromunda Campaign Tracker is a web application developed in PHP with the Symfony framework and the EasyAdmin bundle. It is designed to help Necromunda (Community Edition 2021) players track their campaigns, manage their gangs, and record battle results.

Table of Contents

Features

  • Campaign tracking: Create and manage campaigns with detailed statistics.
  • Gang management: Track members, equipment, and evolutions of each gang.
  • Battle results: Record battles with detailed reports.
  • Statistical reports: Analyze campaign performance with charts and summaries.

Prerequisites

Before starting, make sure you have the following installed on your machine:

Installation

Clone the repository

git clone https://github.com/your-username/necromunda-campaign-tracker.git
cd necromunda-campaign-tracker

Build the Docker image

From the root directory of the project, run the following command to start the Docker containers:

docker-compose up --build -d

Install dependencies

Once the Docker containers are running, access the PHP container and install the Composer dependencies:

docker-compose exec php-fpm bash
composer install

Configuration

.env.local file

Create a .env.local file in the project root for installation-specific variables and specify the database URL:

DATABASE_URL="mysql://user:[email protected]:3306/necromunda"

Database migration

Run the migrations to create the necessary tables in the database:

php bin/console doctrine:migrations:migrate

Production setup

To deploy this project in production, don't forget to compile the asset mapper.

php bin/console asset-map:compile

Backup the database

This project uses the makinacorpus/db-tools-bundle package to automatically back up the database, ensuring the possibility of restoring it in case of issues. To perform a manual backup, you can run the following command:

php bin/console db-tools:backup

To restore a previous backup in case of a problem, use the following command:

php bin/console db-tools:restore

Usage

Access the application by opening your browser and visiting http://localhost:8000.

Admin

Granting admin status to a user allows them to access more menus and modify custom rules. To do this, add the role ["ROLE_ADMIN"] in the MySQL database for the user.

Custom rules

Custom rules have been added to the base game. These rules can be enabled from the "Custom Rules" tab, which is only accessible to the site admin.

Contributing

Contributions are welcome! Please follow the steps below to contribute:

Fork this repository

Create a branch for your feature:

git checkout -b feature/AmazingFeature

Commit your changes:

git commit -m 'Add some AmazingFeature'

Push your branch:

git push origin feature/AmazingFeature

Open a Pull Request.

License

This project is licensed under the GNU License. See the LICENSE file for more details.

Disclaimer

This project, Necromunda Campaign Tracker, is a personal and non-commercial project. It uses data and content from the Necromunda board game, created by Games Workshop. Necromunda and all associated trademarks and names are the property of Games Workshop.

This project is in no way affiliated with, sponsored, or approved by Games Workshop. All data and content used in this project are the property of their respective owners and are used solely for non-commercial and educational purposes.