⚔️ Clash of Spears API REST

⌨️ with ❤︎ by MuXeD

GitHub Status

Demo deploy status

🎱 Introduction

If your enemy is secure at all points, be prepared for him. If he is in superior strength, evade him. If your opponent is temperamental, seek to irritate him. Pretend to be weak, that he may grow arrogant. If he is taking his ease, give him no rest. If his forces are united, separate them. If sovereign and subject are in accord, put division between them. Attack him where he is unprepared, appear where you are not expected .
- Sun tzu, The Art of War

This is a simple NOT OFICIAL API REST to get data from game Clash of Spears.

For any question about game use Books or contact the creators:

• Fighting Hedgehog
• Clash of Spears Facebook
• The warhammer spot

☕️ Buy Me a Coffee

🐛 Report a bug

Please follow one of this links to report a bug:

• Github issues
• Discord

💻 Development

To fix bugs or simply check code.

Requirements:

• Install MariaDB (and create a database called clash-of-spears)
• Node 12 at least

Clone the repo

git clone https://github.com/juananmuxed/clash-of-spears-api.git

Access to the folder

cd clash-of-spears-api

Run NPM to install dependencies and run dev environment

cd npm i
cd npm run dev

Clone .env.example or rename as .env

And you can access to the swagger via web browser in http://localhost:3000/swagger

Docker production

Create a .env.production with params of DB and run npm run docker:deploy

Remember you need a Database with a name-of-table table chosen in the .env.production file.

🏗 Built with

• Express

📌 Versions

Used SemVer for versions. For all available version, see tags.

And here the Changelog

🍰 Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests.

📄 License

This project is under license (MIT) - see LICENSE for details.