Navigation Menu

Skip to content

Commit

Permalink
370 adding readme, conversion to maven, adding editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
mesner committed Mar 1, 2018
1 parent 5cbbcbf commit fc3ce3b
Show file tree
Hide file tree
Showing 7 changed files with 93 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .editorconfig
@@ -0,0 +1,16 @@
# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Markup, config and source code files
[*.{htm,html,md,js,json,jsx,yml}]
charset = utf-8
indent_style = tab
indent_size = 2
trim_trailing_whitespace = true
5 changes: 5 additions & 0 deletions .gitignore
Expand Up @@ -8,6 +8,11 @@
*.war
*.ear

.idea/
*.iml

target/

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
/bin/
23 changes: 22 additions & 1 deletion README.md
@@ -1 +1,22 @@
# Charting-Library---Java-Seed-Project
## Questions and support

If you have questions or get stuck using this project or the ChartIQ Charting Library, the dev support team can be reached through [dev@chartiq.com](mailto:dev@chartiq.com).

# Charting-Library---Java-Seed-Project

This is a basic JavaFX project that utilizes JxBrowser [https://www.teamdev.com/jxbrowser] to display the ChartIQ
Charting Library within a browser view control.

## Requirements

- An HTTP server running a copy of the ChartIQ library, version 3.0+ is required. To get your copy, visit https://www.chartiq.com/products/html5-charting-library/ to see a demo and get in touch with us.
- A JxBrowser license (license.jar) is required, and must be placed on the classpath. An evaluation license can be obtained from [https://www.teamdev.com/jxbrowser].
- A Java JDK is required, and an Apache Maven pom file (pom.xml) lists the required library dependencies of the project.

## Getting started

- You will need a webserver running the ChartIQ Charting Library.
The url of your webserver will need to be copied into the `stxUrl` variable in `ChartIQSample.java`
- The JxBrowser `license.jar` license file will need to be copied into a directory on the classpath of the application.
- Running the application should launch a JavaFX window with the JxBrowser with a text input for you to enter a symbol.
Clicking "Lookup" will fetch data from ChartIQ's quote simulator and populate a chart.
49 changes: 49 additions & 0 deletions pom.xml
@@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.chartiq</groupId>
<artifactId>Charting-Library---Java-Seed-Project</artifactId>
<version>0.0.1-SNAPSHOT</version>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>

<!--<build>-->
<!--<resources>-->
<!--<resource>-->
<!--<directory>lic</directory>-->
<!--</resource>-->
<!--</resources>-->
<!--</build>-->

<repositories>
<repository>
<id>com.teamdev</id>
<url>http://maven.teamdev.com/repository/products</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.teamdev.jxbrowser</groupId>
<artifactId>jxbrowser</artifactId>
<version>6.19</version>
</dependency>
<dependency>
<groupId>com.teamdev.jxbrowser</groupId>
<artifactId>jxbrowser-mac</artifactId>
<version>6.19</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.2</version>
</dependency>
</dependencies>

</project>
File renamed without changes.
Expand Up @@ -6,6 +6,7 @@
import com.teamdev.jxbrowser.chromium.BrowserPreferences;
import com.teamdev.jxbrowser.chromium.internal.Environment;
import com.teamdev.jxbrowser.chromium.javafx.BrowserView;

import javafx.application.Application;
import javafx.application.Platform;
import javafx.scene.Scene;
Expand Down

0 comments on commit fc3ce3b

Please sign in to comment.