Skip to content

cim--/colonia-database

Repository files navigation

Colonia BGS Database

Database for recording and displaying information on the BGS in Colonia

Installation

Clone the repository, then run sh build.sh (You can also run this script after updating the repository)

You will also need to run at least some of the database seeds to get started - StateSeeder, StationclassSeeder and FacilitySeeder are essential. The others will set up some (old) initial systems for the region.

You can download a dump of the current database (minus the users table) from https://cdb.sotl.org.uk/cdb.sql

Point your web document root at the /public/ folder.

Add TICK_TIME=XX (where XX is the UTC hour) to the .env file

Update Scripts

Set cron to run php artisan cdb:history at least daily (not at the same time as the tick). This will keep track of expansions and retreats automatically in the history

To read data from EDDN, run php artisan cdb:eddnreader. This will bring in influence and pending state data automatically from EDDN. Traffic/crime levels cannot currently be obtained this way as they are not in the ED Journal.

License

GNU General Public License v3 or later - see License.txt

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Use elsewhere

Using outside of Colonia will require a number of modifications, at least some of which are described in forking.md