Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.14 KB
Raw

Running The API Locally

  1. Install the latest version of node and npm
  2. git clone [email protected]:HackTheStacks/API-Portal.git
  3. npm install
  4. npm start

To start the server (step 4):

npm start

OR for development

npm install -g pm2

pm2 start npm --name "HackathonAPI" -- start --watch

Make a GET request to any of the end points. Postman works well for testing.

Technologies

  • Node - javascript runtime environment used for server applications
  • Express - node's most popular web framework
  • node-fetch - communicates with other APIs
  • xml2json - javascript library for converting XML data to JSON format
  • Moment - parsing and displaying dates and times
  • Lodash - one of the most populate javascript utility libraries
  • AWS Elasticsearch - Amazon's search service
  • Python - programming language we're using for scraping the databases