Skip to content

hybri-id/worlddebt

Repository files navigation

Contributors Forks Stargazers Issues GPLv3License


Logo

World Debt

A clean and simple PWA to show the world coutry's debt information in real time.

Download

Explore the docs »

Screenshots · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

This application shows real time information of country's debt with some additional information like population or GDP. You can import fresh data aswell with a CSV file.

To install this app, just copy all the content on your server, and open install.php script then add the data importing a .csv with the fields required, or use the country_debts.csv that is included with this project.

Use this README.md to get started.

(back to top)

Built With

This section list frameworks/libraries used to bootstrap the project.

  • Apache PHP
  • MySQL PHP

(back to top)

Getting Started

This package is served as is. You can also download individual files alone to fit your needs.

Prerequisites

For Windows installations, you will need to execute Apache server with php and mysql under XAMPP control panel first (or install it as a service so the server starts automatically).

  1. Get it free at Apache Friends XAMPP

Installation

You only need to download the package and copy it to your XAMPP htdocs or public_html directory. Then open the browser, point to your server and run install.php. You can setup the database user and password inside db.php file. You can also import data with .csv files.

(back to top)

Usage

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Installation script.
  • CSV data import.
  • CSV data export.
  • AJAX searchbox.
  • Detailed information page.
  • Sorting options.
  • PWA installation.
  • Responsive layout.
  • Add country's flags.
  • Add more statistics and/or facts.
  • Multi-currency Support:
    • USD
    • EUR
    • Others

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 features/worlddebtFeatures)
  3. Commit your Changes (git commit -m 'Add some worlddebtFeatures')
  4. Push to the Branch (git push origin features/worlddebtFeatures)
  5. Open a Pull Request

(back to top)

License

Distributed under the Apache-2.0 license. See LICENSE.md for more information.

(back to top)

Contact

Kylo_Rey (aka HybriiD) - out_1990@hotmail.es

Project Link: https://github.com/hybri-id/worlddebt

LinkedIn Twitter

(back to top)

trophy

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

A clean real time world debt clock.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published