namakurohman93 / ytkt

Your Travian: Kingdom Tool

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ytkt

Your Travian: Kingdom Tool. This project is inspired by the Travian Kingdom Tool.

The idea is, instead using official API data from Travian: Kingdom that updated once a day, ytkt using your session to get map data so you can get updated data every hour without waiting for the official one.

Installation

Make sure you already install node js and clone this repo.

npm run install-all
npm run build
npm start

Open your browser then access localhost:3000

To custom port, use export PORT=<desired port>. Example :

export PORT=80
npm start

Open your browser then access localhost:80

Docker

ytkt come with Dockerfile, so you can build an image docker. Or you can pull the image docker from docker hub. You can get ytkt image here.

Build an image docker and run it

docker build --tag ytkt .
docker run \
  -dp <desired port>:3000 \
  -v <desired directory>:/usr/ytkt/data \
  --name ytkt \
  ytkt

Pull the image from docker hub and run it

docker container run \
  -dp <desired port>:3000 \
  -v <desired directory>:/usr/ytkt/data \
  --name ytkt \
  didadadida93/ytkt

Open your browser then access localhost:<desired port>

Development

For development purpose, you need to generate session from Travian: Kingdom. The session need to be put on .env file. You can edit .env.template file and rename it to .env file. After that run these command

npm run dev

Front-end

For those who want to develop front-end, access localhost:8000 and make change on client folder.
The client it self using react js

Back-end

For those who want to develop back-end, access localhost:3000/api/ and make change on ytkt directory.
The back-end it self using express js

About

Your Travian: Kingdom Tool

License:MIT License


Languages

Language:JavaScript 97.4%Language:HTML 1.9%Language:Dockerfile 0.4%Language:CSS 0.3%