boxcat

Outsourced annotation and categorization platform for training and validating data for AI applications.

Getting Started

Installation

git clone https://github.com/magnet2021/boxcat.git
cd boxcat

Note: You will need at least NodeJS 10.18.1+, VSCode 1.44+, Yarn 1.17.3+ and MongoDB 3+. You will also need to configure .env variables before launching.

Configuring Environment Variables

# Environment Config
# Store your secrets and config variables in here
# reference these in code with process.env.ENV_VARIABLE

PORT=3000
DB_URL=mongodb://mongodb.example.com:27017

# Note: MongoDB URI must be in the mongodb:// protocol, the mongodb+srv:// protocol is not supported

Create a file named .env to be able to interact with process.env in NodeJS.

Usage

boxcat follows the latest maintenance LTS version of Node.

yarn
yarn start:dev
# build: yarn build
# production: yarn start

Visit localhost:3000 to view the application.

＼＿ﾍ(◕‿◕ ✰)