Skip to content

Commit 088a0eb

Browse files
mjbriggsmjbriggs
committed
2nd commit
1 parent a984906 commit 088a0eb

File tree

3 files changed

+240
-2
lines changed

3 files changed

+240
-2
lines changed

‎LICENSE

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

‎README.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# flair
2-
fork from the FLAIR project at Tuebingen University
1+
# FLAIR (Foreign Language Acquisition Information Retrieval)
2+
3+
Forked from [FLAIR project](http://sifnos.sfs.uni-tuebingen.de/FLAIR/), which
4+
provides web search for language learning. The upstream version of FLAIR has
5+
English and German modules. We intend to extend FLAIR with other language
6+
modules, beginning with Russian.
7+
8+
# Relevant citations
9+
10+
```
11+
@inproceedings{chinkina2016linguistically,
12+
title={Linguistically aware information retrieval: Providing input enrichment for second language learners},
13+
author={Chinkina, Maria and Meurers, Detmar},
14+
booktitle={Proceedings of the 11th Workshop on Innovative Use of NLP for Building Educational Applications},
15+
pages={188--198},
16+
year={2016}
17+
}
18+
```
19+
20+
## Installation
21+
22+
FLAIR utilizes a maven build system. In order to compile this project, maven must be installed. For more information on using maven, click here https://maven.apache.org/. Additionally, please make sure you have the correct java version. FLAIR is built using java 8.
23+
24+
## Using Bing API
25+
26+
FLAIR utlizes the Bing search api. In order to access Bing's services, you must create an account with Microsoft Azure. You can sign up for a free Microsoft account here https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/. This account will provide you with many service options. For this project you must create a Cognitive Services resource.
27+
28+
There are multiple ways of storing this api key. FLAIR is expecting the api key to be stored in an environment variable called BING_API. There is also a text file reader in the utilities folder available for use if you wish to store your api key in a text file.

‎pom.xml

+211
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
4+
5+
<modelVersion>4.0.0</modelVersion>
6+
<groupId>com</groupId>
7+
<artifactId>flair</artifactId>
8+
<packaging>war</packaging>
9+
<version>2.0</version>
10+
<name>FLAIR</name>
11+
12+
<properties>
13+
<!-- Convenience property to set the GWT version -->
14+
<gwtVersion>2.8.0</gwtVersion>
15+
16+
<!-- GWT needs at least java 1.7 -->
17+
<maven.compiler.source>1.8</maven.compiler.source>
18+
<maven.compiler.target>1.8</maven.compiler.target>
19+
20+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
21+
</properties>
22+
23+
<dependencyManagement>
24+
<dependencies>
25+
<dependency>
26+
<groupId>com.google.gwt</groupId>
27+
<artifactId>gwt</artifactId>
28+
<version>${gwtVersion}</version>
29+
<type>pom</type>
30+
<scope>import</scope>
31+
</dependency>
32+
</dependencies>
33+
</dependencyManagement>
34+
35+
<dependencies>
36+
<dependency>
37+
<groupId>org.apache.httpcomponents</groupId>
38+
<artifactId>httpcore</artifactId>
39+
<version>4.4.6</version>
40+
</dependency>
41+
<dependency>
42+
<groupId>org.apache.httpcomponents</groupId>
43+
<artifactId>httpclient</artifactId>
44+
<version>4.5.3</version>
45+
</dependency>
46+
<dependency>
47+
<groupId>net.sourceforge.nekohtml</groupId>
48+
<artifactId>nekohtml</artifactId>
49+
<version>1.9.22</version>
50+
</dependency>
51+
<dependency>
52+
<groupId>com.google.gwt</groupId>
53+
<artifactId>gwt-servlet</artifactId>
54+
<scope>runtime</scope>
55+
</dependency>
56+
<dependency>
57+
<groupId>com.google.gwt</groupId>
58+
<artifactId>gwt-user</artifactId>
59+
<scope>provided</scope>
60+
</dependency>
61+
<dependency>
62+
<groupId>com.google.gwt</groupId>
63+
<artifactId>gwt-dev</artifactId>
64+
<scope>provided</scope>
65+
<exclusions>
66+
<exclusion>
67+
<groupId>net.sourceforge.nekohtml</groupId>
68+
<artifactId>nekohtml</artifactId>
69+
</exclusion>
70+
<exclusion>
71+
<groupId>org.eclipse.jetty</groupId>
72+
<artifactId>apache-jsp</artifactId>
73+
</exclusion>
74+
</exclusions>
75+
</dependency>
76+
<dependency>
77+
<groupId>com.github.gwtmaterialdesign</groupId>
78+
<artifactId>gwt-material</artifactId>
79+
<version>2.0-rc7</version>
80+
</dependency>
81+
<dependency>
82+
<groupId>com.github.gwtmaterialdesign</groupId>
83+
<artifactId>gwt-material-addins</artifactId>
84+
<version>2.0-rc7</version>
85+
</dependency>
86+
<dependency>
87+
<groupId>com.github.gwtmaterialdesign</groupId>
88+
<artifactId>gwt-material-themes</artifactId>
89+
<version>2.0-rc7</version>
90+
</dependency>
91+
<dependency>
92+
<groupId>org.slf4j</groupId>
93+
<artifactId>slf4j-simple</artifactId>
94+
<version>1.7.25</version>
95+
</dependency>
96+
<dependency>
97+
<groupId>org.slf4j</groupId>
98+
<artifactId>slf4j-api</artifactId>
99+
<version>1.7.25</version>
100+
</dependency>
101+
<dependency>
102+
<groupId>org.apache.tika</groupId>
103+
<artifactId>tika-core</artifactId>
104+
<version>1.14</version>
105+
</dependency>
106+
<dependency>
107+
<groupId>org.apache.tika</groupId>
108+
<artifactId>tika-parsers</artifactId>
109+
<version>1.14</version>
110+
</dependency>
111+
<dependency>
112+
<groupId>com.github.gwtd3</groupId>
113+
<artifactId>gwt-d3-api</artifactId>
114+
<version>1.3.0</version>
115+
</dependency>
116+
<dependency>
117+
<groupId>edu.stanford.nlp</groupId>
118+
<artifactId>stanford-corenlp</artifactId>
119+
<version>3.9.2</version>
120+
</dependency>
121+
<dependency>
122+
<groupId>edu.stanford.nlp</groupId>
123+
<artifactId>stanford-corenlp</artifactId>
124+
<version>3.9.2</version>
125+
<classifier>models-english</classifier>
126+
</dependency>
127+
<dependency>
128+
<groupId>edu.stanford.nlp</groupId>
129+
<artifactId>stanford-corenlp</artifactId>
130+
<version>3.9.2</version>
131+
<classifier>models-german</classifier>
132+
</dependency>
133+
134+
<!-- Local Dependencies -->
135+
<dependency>
136+
<groupId>edu.stanford.nlp</groupId>
137+
<artifactId>stanford-tregex</artifactId>
138+
<version>3.6.0</version>
139+
<scope>system</scope>
140+
<systemPath>${project.basedir}/src/main/webapp/WEB-INF/lib/stanford-tregex-3.6.0.jar</systemPath>
141+
</dependency>
142+
</dependencies>
143+
144+
<build>
145+
<!-- Output classes directly into the webapp, so that IDEs and "mvn process-classes"
146+
update them in DevMode -->
147+
<outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>
148+
149+
<plugins>
150+
<plugin>
151+
<artifactId>maven-war-plugin</artifactId>
152+
153+
<configuration>
154+
<recompressZippedFiles>false</recompressZippedFiles>
155+
</configuration>
156+
</plugin>
157+
158+
<!-- Mojo's Maven Plugin for GWT -->
159+
<plugin>
160+
<groupId>org.codehaus.mojo</groupId>
161+
<artifactId>gwt-maven-plugin</artifactId>
162+
<version>2.8.0</version>
163+
<executions>
164+
<execution>
165+
<goals>
166+
<goal>compile</goal>
167+
<goal>test</goal>
168+
<goal>generateAsync</goal>
169+
</goals>
170+
171+
<configuration>
172+
<compileReport>true</compileReport>
173+
<failOnError>true</failOnError>
174+
<printJavaCommandOnError>true</printJavaCommandOnError>
175+
<classpathScope>compile+runtime</classpathScope>
176+
</configuration>
177+
</execution>
178+
</executions>
179+
180+
<!-- Plugin configuration. There are many available options, see gwt-maven-plugin
181+
documentation at codehaus.org -->
182+
<configuration>
183+
<superDevMode>false</superDevMode>
184+
185+
<runTarget>FLAIR.html</runTarget>
186+
<modules>
187+
<module>com.flair.FLAIR</module>
188+
</modules>
189+
</configuration>
190+
</plugin>
191+
192+
<!-- Copy dependencies to the webapp folder -->
193+
<plugin>
194+
<artifactId>maven-dependency-plugin</artifactId>
195+
<executions>
196+
<execution>
197+
<phase>prepare-package</phase>
198+
199+
<goals>
200+
<goal>copy-dependencies</goal>
201+
</goals>
202+
<configuration>
203+
<outputDirectory>${project.basedir}/src/main/webapp/WEB-INF/lib</outputDirectory>
204+
</configuration>
205+
</execution>
206+
</executions>
207+
</plugin>
208+
</plugins>
209+
</build>
210+
211+
</project>

0 commit comments

Comments
 (0)