Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solbero/ti4-mapmaker-api
https://github.com/solbero/ti4-mapmaker-api
deta fastapi twilight-imperium
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/solbero/ti4-mapmaker-api
- Owner: solbero
- License: gpl-3.0
- Created: 2022-08-03T09:53:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-20T20:13:44.000Z (about 2 years ago)
- Last Synced: 2024-10-28T11:44:23.696Z (2 months ago)
- Topics: deta, fastapi, twilight-imperium
- Language: Python
- Homepage: https://ti4-mapmaker-api.deta.dev/
- Size: 139 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
TI4 Mapmaker API
API for the Twilight Imperium 4 Mapmaker map generator website
## About the Project
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](https://fastapi.tiangolo.com/) application which is deployed at [Deta](https://www.deta.sh/) using their Micro and Base services.
## Prerequisites
You must have the following programs installed:
* Python 3.9
* [Poetry](https://python-poetry.org/docs/#installation)
* [Deta CLI](https://docs.deta.sh/docs/cli/install)
## Installation
Clone the repository,
```sh
git clone https://github.com/solbero/ti4-mapmaker-api.git
```
move into the project directory,
```sh
cd ti4-mapmaker-api
```
and install the project.
```sh
poetry install
```
Then, create a Deta Micro for the project
```sh
deta new --python
```
and a `.env` file in the project's root directory. Paste in
```
DETA_PROJECT_KEY=
```
and replace `` with your Deta project credentials.
## Running
To run the project locally
```sh
poetry run python main.py
```
## Testing
To run the project's testing suite
```sh
poetry run pytest
```
## Deployment
To deploy the project to Deta Micro
```sh
deta deploy
```
## Contributions
* Gamedata from [TI4 Generator](https://github.com/KeeganW/ti4) by [KeeganW](https://github.com/KeeganW)
## Contact
* Email: [[email protected]](mailto:[email protected])
## Project Links
* Github: [https://github.com/solbero/ti4-mapmaker-api](https://github.com/solbero/ti4-mapmaker-api)
## License
Distributed under the GPLv3 License.
See [`LICENSE.txt`](https://github.com/solbero/hexpex/blob/master/LICENSE.txt) for more information.