Set up development environment.

quangis · Sep 9, 2022 · 4ae9cf8 · 4ae9cf8
1 parent 9591dbe
commit 4ae9cf8
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+node_modules/
+dist/
+.parcel-cache/
 build/
 run/
 

diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# gis-question-formulator
+
+This repository, right now, contains two projects that contain some 
+overlap:
+
+1.  A `blockly` interface in JavaScript to allow the user to construct a 
+    question in constrained natural language.
+2.  A natural language parser, using machine learning and ANTLR, that 
+    identifies functional roles from a question, and produces the 
+    underlying transformation graph.
+
+The first of these is at the root of the repository. The second is in 
+the [`parser_module/`](parser_module/) subdirectory. We are working 
+towards unifying this functionality; see [issue 
+#1](https://github.com/quangis/geo-question-parser/issues/1) for 
+details.
+
+
+## Installation
+
+First, you will need to install [NPM][npm]. Do so via your method of 
+choice; note that it is available on [`conda-forge`][conda-nodejs]. 
+After that, install the environment:
+
+    npm install
+
+To have [Parcel][parcel] run a test server at `http://localhost:1234`, 
+do:
+
+    npm run start
+
+
+[npm]: https://www.npmjs.com/
+[parcel]: https://parceljs.org/
+[conda-nodejs]: https://anaconda.org/conda-forge/nodejs
diff --git a/package.json b/package.json
@@ -0,0 +1,42 @@
+{
+  "name": "gis-question-formulator",
+  "version": "0.0.0",
+  "description": "The question formulator for GIS questions in the QuAnGIS project. It ships a user interface based on Blockly.",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "parcel public/index.html",
+    "build": "parcel build public/index.html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quangis/gis-question-formulator.git"
+  },
+  "keywords": [
+    "GIS",
+    "blockly",
+    "core",
+    "concepts",
+    "geographical",
+    "information",
+    "geo-analytical",
+    "question",
+    "answering"
+  ],
+  "author": "Haiqi Xu, Niels Steenbergen, Enkhbold Nyamsuren, Simon Scheider, Eric Top",
+  "license": "GPL-2.0-or-later",
+  "bugs": {
+    "url": "https://github.com/quangis/gis-question-formulator/issues"
+  },
+  "homepage": "https://github.com/quangis/gis-question-formulator#readme",
+  "dependencies": {
+    "blockly": "^8.0.5"
+  },
+  "devDependencies": {
+    "parcel": "next",
+    "parcel-reporter-static-files-copy": "^1.3"
+  },
+  "staticFiles": {
+    "staticPath": "node_modules/blockly/media",
+    "staticOutPath": "media"
+  }
+}
diff --git a/index.html → public/index.html b/index.html → public/index.html
@@ -35,8 +35,8 @@
 			font-size: 25px;
 		}
 	</style>
-	<script src="blocks.js"></script>
-	<script src="generator.js"></script>
+	<script src="../src/blocks.js"></script>
+	<script src="../src/generator.js"></script>
 	<link rel="shortcut icon" href="#" />
 </head>
 <body>

diff --git a/blocks.js → src/blocks.js b/blocks.js → src/blocks.js
diff --git a/generator.js → src/generator.js b/generator.js → src/generator.js