Add a simple backend health check endpoint (/health)

Open Beginner friendly
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
flask, python
Domain
api, backend

Research direction

Start at the Flask backend application entry point and review how its existing routes are defined. Add the requested GET /health route, then verify that it returns HTTP 200 with a JSON body containing status: ok.

Written by the indexing model from the issue text.

Description

Summary

Currently, there is no dedicated health check endpoint to verify that the Flask backend is running correctly.

Adding a lightweight /health endpoint would make it easier to:

  • Verify backend availability
  • Support deployment checks
  • Integrate with CI or monitoring tools in the future

Proposed Improvement

Add a simple route:

@app.route("/health", methods=["GET"])
def health():
    return jsonify({
        "status": "ok"
    }), 200

Benefits
  • Useful for development and debugging

  • Helps validate server startup

  • Future-ready for monitoring or deployment automation

Dominant language
CSS
Stars
22
Forks
28
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OSeMOSYS/MUIO

All issues in OSeMOSYS/MUIO

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.