https://github.com/ebitkov/prun-community-report

An unofficial economy report for the game "Prosperous Universe" made by the community and aggregated with data from the FIO REST API.
https://github.com/ebitkov/prun-community-report

prosperous-universe

Last synced: 12 months ago
JSON representation

An unofficial economy report for the game "Prosperous Universe" made by the community and aggregated with data from the FIO REST API.

• Host: GitHub
• URL: https://github.com/ebitkov/prun-community-report
• Owner: ebitkov
• License: mit
• Created: 2025-04-17T09:05:52.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-13T17:08:00.000Z (about 1 year ago)
• Last Synced: 2025-06-13T17:39:15.474Z (about 1 year ago)
• Topics: prosperous-universe
• Language: PHP
• Homepage:
• Size: 342 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Prosperous Universe Community Report

This is an unofficial economic report for [Prosperous Universe](https://prosperousuniverse.com/), made by the community,

with data from the [FNAR FIO API](https://doc.fnar.net/).

> [!NOTE]

> This project is still in development. The code, design and features can change drastically.

## Development

### Stack

- **PHP 8.2**

- **Symfony 7.2**, which includes i. a.:

    - **[Twig](https://twig.symfony.com/)** for templating

    - **[Doctrine](https://www.doctrine-project.org/)** for database object management

    - **[AssetMapper](https://www.doctrine-project.org/)** for asset management

    - **[Stimulus](https://ux.symfony.com/stimulus)** for interactive components

    - **[Chart.js](https://symfony.com/bundles/ux-chartjs/current/index.html)** for the graphs

### Installation

You'll need to have PHP and [Composer](https://getcomposer.org/) installed.

After cloning the repository:

1. Run `composer install` to install the dependencies

2. Run `php bin/console doctrine:migrations:migrate` to setup the local database (SQLite).

3. [Sync the required data from FIO](https://github.com/ebitkov/prun-community-report/wiki/How-to-Sync-Data-from-FIO%3F)

4. Run `php bin/console server:run` to start the local web server. After that, you can access the application at

   `http://localhost:8000`.

### Testing

Testing will be done with PHPUnit, but isn't implemented yet. All tests are manually at the moment.

### Contribution

Contributions are welcome! Please review the issues for current tasks and projects and feel free to open a new issue or

pull request.