dutylog/db-config/README.md

31 lines
1.4 KiB
Markdown
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# dutylog.app DB Schema
This repository will house any initialization scripts, constant data, design notes, and really anything else related to the database.
## Design Notes
All activities will be stored in our own database for simplicity and so that data can be formatted in a usable setup. Activity names will not be stored in the DB and instead will live in a `[type].[lang].json` file in their game translated forms.
The current plan is to host this database on Cloudflare D1, which is based on SQLite.
## Translations
Current translation file list:
- `language.[lang].json`
- Holds application translations
- `servers.[lang].json`
- Holds translations for servers (Crystal/Aether) and worlds (Brynhildr/Adamantoise)
- `expansions.[lang].json`
- Holds translations for expansions (A Realm Reborn/Heavensward)
- `instance_types.[lang].json`
- Holds translations for duty types (Dungeon/Raid)
- `instances.[lang].json`
- Holds translations for duty names (The Binding Coil of Bahamut - Turn 1/The Thousand Maws of TotoRak)
- `jobs.[lang].json`
- Holds translations for jobs (Machinist/Paladin)
These files will be generated by the DB initialization script and will need to be moved to the `www` repo for build/deployment.
## Schema
The schema was designed using [Dia](http://dia-installer.de/).
![schema.png](https://git.milligan.dev/xivdev/dutylog/raw/branch/master/db-config/schema.png)