karafra/bunkers-of-slovakia

🗺️ Interactive map of bunkers in Slovakia 🇸🇰

Bunkers of Slovakia

Simple interactive map of Slovakian war bunkers
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Simple interactive map of all publicly known bunkers in Slovakia, map includes WW1, WW2, Cold war and post cold war bunkers.

(back to top)

Built With

• React.js
• Deck.gl
• Jest
• Prettier
• DeckTypings

(back to top)

Getting Started

Prerequisites

For running this project you need Node.js and Yarn.

• Node.js

  For installing Node.js follow steps mentioned here

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/karafra/bunkers-of-slovakia.git

2. Install NPM packages

   yarn

3. Run app

   yarn start

Application should now be running at http://localhost:3000 🚀

(back to top)

Usage

Using this application is just as simple as using any other application involving maps such as Google maps. Just scroll and enjoy 🤷

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add CI
• Add Codecov coverage
• Fix top bar as it seems empty
• Add current location pointer

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - @karafro - dariusKralovic@protonmail.com

Project Link: https://github.com/karafra/bunkers-of-slovakia

(back to top)