Skip to content

How to run REST API

Jump to bottom
Ebuka Akubilo edited this page Mar 10, 2025 · 10 revisions

Note: We Dockerized our Crawler. Please follow the instructions in the readme to set up the Crawler with Docker. The following instructions are for setting up our Crawler pre-Dockerization, which is deprecated. You can find the files of the pre-dockerized crawler in the June 2024 release, for which these instructions apply.

  1. Navigate to the rest-api folder, and run

    npm install

  2. Create a file named .env with the following information:

    DB_CONNECTION=mysql
DB_HOST=localhost
DB_DATABASE=analysis
DB_USERNAME=root
DB_PASSWORD=

  3. To run the REST API without the debugging table, run

    node index.js

    To run the REST API with the debugging table, run

    node index.js debug

    For more information on the debugging table, see the Wiki.

  4. Open a browser and navigate to http://localhost:8080/analysis and check if you can see the analysis data.

Clone this wiki locally