zsevic / open-borders-server

Back-end for Open borders

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

open-borders-server

Back-end for open-borders

Getting started

Prerequisites

  • Node.js installed (version 14)

Setup

git clone https://github.com/zsevic/open-borders-server
cd open-borders-server
cp .env.sample .env # change values
npm i
npm run start:dev

Build

npm run build
npm start

Linting

npm run lint
npm run lint:fix

Testing

npm test

API documentation

API documentation is generated using @nestjs/swagger module at /api-docs endpoint

Technologies used

  • Node.js, TypeScript, NestJS (for API)
  • puppeteer and cheerio (for scraping)
  • node-nlp (for NLP)

About

Back-end for Open borders

License:MIT License


Languages

Language:TypeScript 99.8%Language:JavaScript 0.1%Language:Dockerfile 0.0%