Skip to content
master
Switch branches/tags
Go to file
Code

README.md

Crypto Alerts, Watchlist and Portfolio Tracking App

Coinwink was first built as a WordPress web-app in 2016, and even now it continues to run on the same stack.

While it is tempting to switch to Laravel + Vue, the current WP + jQuery stack runs great. It is fast, secure, relatively easy to maintain and update.

Only user accounts are on WP, and also the app uses WP MySQL queries. The backend scripts, responsible for alerts delivery, are independent PHP files.

The front-end is a custom-made web-app interface, based on jQuery.

This repository includes all of the latest Coinwink app's source code, including the Matrix theme. The payments module and the captcha plugin are not part of this repository because they are not required for individual Coinwink use.


Quickstart

  • Make a fresh Wordpress install.
  • Copy all files from this repository to your Wordpress installation folder.
  • Copy contents from cryptocurrency-logos repository to your img folder.
  • Set the homePath variable to your Wordpress location in the theme's header.php file.
  • Update auth_sql.php file with your database login details.
  • First of all, in Wordpress "Settings->General" check "Anyone can register".
  • Only then activate Coinwink login plugin.
  • Finally, activate Coinwink theme.

Done!

Open your Wordpress site in your browser. You should see the Coinwink app.

The order of the Quickstart steps is important. Otherwise, you will lock yourself out of Wordpress admin panel. On Coinwink theme's activation, it automatically creates the required pages and sets them to use the correct templates. Additionally, it creates database tables and adds an example CoinMarketCap dataset, and example currency rates. It also promotes the admin user to Premium.


More info

To get new market price data from CoinMarketCap (for alerts, portfolio, and watchlist), register for the Free CMC API plan, and then update your auth_cmc.php and auth_sql.php files with your credentials.

To fetch new data from CMC, run cron_data_cmc.php script.

For new users to receive account activation emails, configure your email settings in auth_email_functions.php php file.

To trigger and send alerts by email and SMS, run the following scripts:

  • cron_alerts_email_cur.php - Email price alerts
  • cron_alerts_email_per.php - Email percentage alerts
  • cron_alerts_sms_cur.php - SMS price alerts
  • cron_alerts_sms_per.php - SMS percentage alerts
  • cron_alerts_portfolio.php - Portfolio alerts

To set the above scripts on auto, use cron jobs.

To receive SMS alerts, sign up on Twilio (click the link to get 10$ free), get your API keys, and update the auth_twilio.php file. Then run the above mentioned SMS scrips to activate and send SMS alerts.

For currency rates conversion, two services are utilized. More info: cron_data_cur_rates.php.

/img/coins folder is for cryptocurrency logos. Our script to update/fetch new logos can be found here.


Screenshots



















Development and Contribution

Coinwink's source code available in this repository is for personal use, also for review, educational, and in general - for non-commercial purposes. Intellectual property assets are protected by law.

For your personal needs, you are allowed to run Coinwink app in your own development environment and to use it as much as you need, without any limits.

You are welcome to report issues, send us your feedback or suggest ideas and improvements. For similar communication, use the issue tracker or contact us by email.

You can find more information about the latest Coinwink developments on our blog:
New Updates (Aug, 2020)
Coinwink Matrix theme (July, 2020)
New updates and features (June, 2020)