CSSG-Labs/flask-todo-app

Create healthcheck endpoint

Open

#9 opened on Apr 9, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (2 assignees)HTML (4 forks)auto 404
backendgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

  • GET request to route returns JSON response:
    • HTTP status code
    • Current datetime
    • Uptime

WHAT:

  • an endpoint that can be used to check if the app is running

WHY:

  • Useful for tests to ensure app is working
  • Useful for future diagnostic checks and reports (ex: database connectivity status)

HOW:

  • Example can be seen in this Express.js article

Contributor guide

Research direction
Add a new route to the Flask app that returns a JSON response with status code, datetime, and uptime. See the linked article for an Express example, but implement in Flask.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonFlask
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90