API developed for web crawling using Node with Typescript.
Requirements • Environment • Instalation • How to run • Api documentation
These instructions will allow you to install and run the web scrapping api, at Api documentation you can run see more about the endpoints.
Example of how .env
file should be structured:
PORT=4390
HOSTNAME=www.example.host.com
To install all dependencies just run the following command:
npm install
After install step we have three options related with the running process:
This case should be used during development time, after each command to save files the project server will restart with the new code.
npm run start:dev
Outside of the development process, this mode is meant for people who want to test requests and analyze logs without having to change files.
npm run start
Obs: This way, changing and saving the files will not restart the server with the latest updates. To do this, restart the server manually or use development mode.
This is the execution mode aimed at the production environment, it will generate a set of optimized files so that the server doesn't suffer from impaired memory performance.
npm run start:prod
This script will remove the /build
directory and creates a new one with all the transpiled files.
This project has all its endpoints documented in Postman as a shared collection, to get a copy of its endpoints:
Thanks and good tests 🎉