Rebuild local setup instructions from project config files

Extract prerequisites and start commands from package files, Docker configs, or env templates. Use this to onboard teammates when README files are missing or broken.

You getA clean markdown guide with three sections: Prerequisites, Step-by-Step Local Setup Commands (with shell code blocks), and Common Boot Pitfalls to verify.

Prompt

Prompt
Act as a developer operations specialist. Generate clear, copy-and-paste local development setup instructions by analyzing the pasted project configuration files.
- Identify required language runtimes, package managers, and external service dependencies (such as databases or caches).
- Derive the logical setup order: installing tools, setting environment variables, installing dependencies, database setup, and running the local server.
- Call out implied environment variables that must be defined before booting.
Output format: A clean markdown guide with three sections: Prerequisites, Step-by-Step Local Setup Commands (with shell code blocks), and Common Boot Pitfalls to verify.

Here are the configuration files:

Example output

Example for: package.json and docker-compose.yml from a Node.js and PostgreSQL app

Prerequisites
  • Node.js version 20.x or higher
  • npm version 10.x
  • Docker and Docker Compose installed and running
Step-by-Step Local Setup Commands
  1. Enter the project folder:
cd my-project
  1. Configure environment variables:
cp .env.example .env

Ensure DATABASE_URL matches your local Docker credentials (postgres://postgres:postgres@localhost:5432/app_dev).

  1. Start backing services:
docker compose up -d postgres redis
  1. Install application dependencies:
npm install
  1. Run database migrations:
npx prisma migrate dev
  1. Start local development server:
npm run dev

The server will be available at http://localhost:3000.

Common Boot Pitfalls
  • Port Conflicts: Ensure local port 5432 is not occupied by an existing local PostgreSQL instance before running Docker Compose.
  • Missing Secrets: Verify .env contains a non-empty SESSION_SECRET; the server terminates on startup if this value is absent.
  • Database Readiness: If migrations fail on step 5, wait 5 seconds for PostgreSQL health checks to pass before rerunning.
Written by AI from this prompt. Your results will vary.

Paste files like package.json, Dockerfile, docker-compose.yml, or .env.example into ChatGPT, Claude, or Gemini. For your follow-up, ask the model to generate a one-line Makefile to run these steps automatically.

Make it repeatable

Keep using this prompt without pasting it in every time.

Keep exploring

More in Coding