/sampling

Tool to streamline manually annotating text documents for NLP project.

Primary LanguageHTML

sampling

Demo

Installation and Setup

Step 0: Dependencies1

  1. Node
  2. MySQL
  3. Git

1 If you are running on a linux distro, install the appropriate dependencies with your package manager of choice

Step 1: Installation

Linux
# Download
git clone https://github.com/tparkerd/sampling.git
# Install
cd sampling && sudo npm install
# Create database
node created_database.js
# Run server
npm start
Windows
# Download
git clone https://github.com/tparkerd/sampling.git
# Install
cd sampling && npm install
# Create database
node created_database.js
# Run server
npm start
Step 2: Create an environment file in root directory (.env)
PORT=<an open port>
DBHOST=localhost
DBUSER=<user of database>
DBPASS=<password for database>
DBNAME=classifier
SECRET=<some secret passphrase>
USERTABLE=users
CLASSIFICATIONTABLE=classifications

Without any errors, you should see the following text in your terminal: Server started and listening on port 3000.

To-dos

  • Add explanation on how samples are annotated