Peek – A visual interface for human readable MongoDB queries

final version is on branch "final-final-showtime"

Installation

Prerequisites

• Docker Desktop > 4.24

Create a Docker image and run it with the following command:

docker compose up --build

Project structure

After successfully building the project consists of several Docker containers

frontend

• React dev environment with hot reloading
• Port 3000 is exposed
• Open http://localhost:3000 in browser
• 📘 Frontend Manual

backend

• Node.js / Express server
• Port 4000 is exposed
• API endpoints are exposed at http://localhost:4000/
• 📘 Backend Manual

reverse proxy

• Nginx server
• Basic reverse proxy config, mapping http port 3000 to port 80
• Frontend is served through nginx @ http://localhost
• 🛠️ Nginx Docs: Reverse Proxy

mongoDB

• MongoDB database
• Default Port 27017 is exposed
• A persistent Docker volume mongodb-data for databases