README.md

Big Browser

A demo application written with NestJS and Vue: a page that displays your HTTP client's user agent information.

Big browser is watching you.

• Installation
  • Requirements
  • Setup
  • Run in development mode
  • Run in production mode
• Configuration

Installation

Requirements

• Node.js 22.x
• Redis 5.x, 6.x or 7.x

Setup

• Clone the repository and install dependencies:

  git clone https://github.com/mediacomem/big-browser
  cd big-browser
  npm ci
  

• Set up environment variables for configuration if needed.

Run in development mode

cd /path/to/application
npm start

Build and run in production mode

cd /path/to/application
npm run build
npm run start:prod

Configuration

The following environment variables can be set to customize the application's behavior:

Variable	Default value	Description
BIG_BROWSER_DATABASE_PREFIX	big-browser	Base URL at which the application is deployed.
BIG_BROWSER_DATABASE_URL (or REDIS_URL)	redis://localhost:6379/0	Redis connection URL.
BIG_BROWSER_FRONTEND_URL	http://localhost:5173	URL to which frontend requests are proxied during development.
BIG_BROWSER_MEMORY	5	Number of previously scanned user agents to remember.
BIG_BROWSER_PORT (or PORT)	3000	Port on which to listen to.