API for the Twilight Imperium 4 Mapmaker map generator website
This is the API for the TI4 Mapmaker map generator website. The API can be queried for information about maps, factions and tiles in the board game Twilight Imperium 4.
The project is a FastAPI application which is deployed at Deta using their Micro and Base services.
You must have the following programs installed:
Clone the repository,
git clone https://github.com/solbero/ti4-mapmaker-api.git
move into the project directory,
cd ti4-mapmaker-api
and install the project.
poetry install
Then, create a Deta Micro for the project
deta new --python
and a .env
file in the project's root directory. Paste in
DETA_PROJECT_KEY=<deta-project-key>
and replace <deta-project-key>
with your Deta project credentials.
To run the project locally
poetry run python main.py
To run the project's testing suite
poetry run pytest
To deploy the project to Deta Micro
deta deploy
- Gamedata from TI4 Generator by KeeganW
- Email: njord.solberg@gmail.com
Distributed under the GPLv3 License.
See LICENSE.txt
for more information.