Skip to content

Latest commit

 

History

History
92 lines (76 loc) · 4.77 KB

README.md

File metadata and controls

92 lines (76 loc) · 4.77 KB

Link to ukrainian "readme" avaible here

Welcome to CryptoViewer! - currency viewer

CoinViewer - program for viewing currencies. Supports searching, viewing and saving currencies, and also contains a calculator for converting currency from one value to another. Requires internet! Built on the CryptingUp API

Menu

The program interface consists of the following elements:

  • title - name of the section;
  • sidebar - contains the usual navigation for switching between sections;
  • content - content and elements of the section.

Title

The title serves to display the name of the open section;

Sidebar

The sidebar is an area for switching between sections, containing buttons. To enlarge the panel, click on the burger button, which enlarges the side panel and displays the full name of the buttons. There are only four buttons:

  • Main menu;
  • Saved;
  • Currency calculator;
  • Settings.

Section

A section is a separate page that performs a certain role. In total, there are the following sections:

  • Main menu - contains search for elements by their name;
  • Saved - contains currencies saved by the user;
  • Currency calculator - converts currency from one value to another;
  • Settings - changes the rules of the program.

Main menu

The main menu is a section containing a search field for finding currencies by their name. Opens by default at the start and also contains 10 returned currencies. During the search, you can either click on the currency or save. If we click on it, we will get the content of the currency. To save the currency, you should click on the "star" icon, which will save the currency to the local memory. To remove from the saved ones, you should click again on the star so that only its borders are filled.

Saved

Savings contain a list of currencies saved by the user. They can also be removed by clicking on the star.

Currency calculator

The currency calculator is a converter that accepts two currencies as input, which are selected from the list of available ones, and is converted into the corresponding currency.

Settings

The settings include the following parameters:

  • changes in the language of the interface, which supports English and Ukrainian languages;
  • theme changes (bright or dark)

Changes are applied when the program is started again.

Code

CryptingUp

A library containing the following classes has been created to work with the CryptingUp API:

Class Value Reference to retrieve data
Asset Assets https://cryptingup.com/api/assets
BaseAsset Base asset https://cryptingup.com/api/assetsoverview
Exchange Exchange companies https://cryptingup.com/api/exchanges
Market Market https://cryptingup.com/api/markets
QuoteExchange Quote Exchange Obtained from Exchange
QuoteMarket Market Exchange Obtained from Market
QuoteAsset Asset Exchange Obtained from Asset
Attention! when receiving data in parts, the pointer to the following data was incorrectly generated by the site. Therefore, some methods indicate that it should not be used.

Local data

The CryptoViewer.Local project containing the static classes LocalData and LocalHashListAsset has been created to work with data storage and loading files.

LocalData

To save settings information, there is a LocalData structure that contains the following properties:

Property Name Value Application
LangName Language name (uk_UA, en_US) Saving the language value
Theme Theme (light or dark) Save the theme value
IndexSelectTheme Topic Index Applies to parameter lists
IndexSelectLang Language Index Applies to parameter lists

LocalHashListAsset

LocalHashListAsset - a static class that performs functions of saving the list of currencies chosen by the user. Built on top of HashSet. Contains the following properties:

Property Type Value
Values IPropertySet Access local storage fields
Current IReadOnlyCollection Get a collection of saved currencies as strings
Count int Get the number of stored items

Methods of the static class LocalHashListAsset:

Method Type Value
Init(IPropertySet values) void Initialization based on the IPropertySet interface
Add(string s) bool Add a string. Returns true if the string is added. False if the string is empty (or null) or has been added
Remove(string s) bool Remove the string. Returns true if the string is deleted, false otherwise
Clear() void Clears all items from local storage
Save() void Saves changes to the repository. Called by Add, Remove and Clear methods
Contains(string str) bool Checks if a string exists

Requirements

The minimum version required to work with the program is Windows 10 (10.0; Build 10240). If the program does not start, check the network connection.