MediaComem / revprod-backend

Backend for The Revolutionary Product, a multi-component web application to illustrate CORS and reverse proxying

The Revolutionary Product - Backend

Backend for The Revolutionary Product, a multi-component web application to illustrate CORS and reverse proxying.

• Requirements
• Development
• Production
• Configuration

Requirements

• Node.js 20.x

Development

# Clone and move into the repository
git clone https://github.com/MediaComem/revprod-backend.git
cd revprod-backend

# Install dependencies
npm ci

# Run the application in development mode
npm run dev

Production

# Clone and move into the repository
git clone https://github.com/MediaComem/revprod-backend.git
cd revprod-backend

# Install dependencies
npm install --production

# Run the application in development mode
REVPROD_LANDING_PAGE_BASE_URL=https://revprod.example.com node ./bin.js

Configuration

The application can be configured using the following environment variables:

Variable	Default value	Description
REVPROD_LANDING_PAGE_BASE_URL	-	The public URL at which the revprod landing page can be accessed.
REVPROD_LISTEN_HOST	0.0.0.0	The IP address to listen to (use 0.0.0.0 for any IP address).
REVPROD_LISTEN_PORT	3000	The port to listen on.
REVPROD_CORS	false	Whether to enable CORS.
REVPROD_CORS_ORIGINS	-	Comma-separated list of CORS origins to allow (all by default).
REVPROD_DB_FILE	db.json (relative to the application)	The file in which the embedded database will be stored.
REVPROD_TITLE	The Revolutionary Product	The title displayed in the navbar.
REVPROD_LOG_LEVEL	DEBUG in production, TRACE otherwise	The highest level of log messages to output.

In development mode, you can also put these settings in a .env file in the repository. See the .env.sample file.