Skip to main content

F4. Run your app locally

What this page helps you do​

Get the app running on your own machine in a repeatable way.

Why it matters​

If the app does not run cleanly on a fresh local setup, production will be harder, not easier. Local run problems usually expose missing dependencies, missing environment settings, or undocumented steps.

You should already have​

  • the code in GitHub or at least in a local repo
  • the main dependencies installed

Skip this page if​

  • another person can already clone the project and run it from the documented steps

Then go to B2. Already running locally.

What to do​

  1. Install the project dependencies.
  2. Set the required environment settings.
  3. Run the app with the documented command.
  4. Open the app and confirm the core path works.
  5. Write down the exact local run steps in the README or docs.

Good enough proof looks like this:

  • a new machine can install dependencies
  • the app starts with one documented command
  • the builder knows which settings are required

Prefer one clear start command, even if you later add more advanced workflows.

Examples:

npm install
npm run dev

or

docker compose up

Only use Docker if it truly makes the setup simpler for your project, not just because it sounds more professional.

Common mistakes​

  • “works on my machine” because old dependencies were left installed
  • hidden manual setup steps
  • skipping local verification and trying to debug everything in production

Next step​

Go to H1. Choose hosting.

Advanced notes​

If your app needs several services locally, document the minimum working setup first. Advanced local flows can come later.