bcgov/wps

CFFDRS API: Hello World

Offen

#2.275 geöffnet am 14.09.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (10 Forks)auto 404
4RefinementGood First IssueTask

Repository-Metriken

Stars
 (65 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Describe the task First baby step towards making our own CFFDRS API microservice.

Acceptance Criteria

  • Uses FastAPI to create an app that says "Hello world"
  • Deploys all the way through to prod with GH Actions
  • The project will have to be licensed as GPL to comply with the CFFDRS license.
  • Using a familiar stack with poetry + python + fastapi

Additional context

  • Stick with our existing stack for now because it's familiar
  • In anticipation of using Python implementation in CFF API instead of R package

Contributor Guide

Research-Richtung
Erkunde die bestehende Repository Struktur, um ähnliche Mikrodienste zu finden, und verstehe die FastAPI Einrichtungs , Test und Bereitstellungsmuster in GitHub Actions. Identifiziere, wie andere Dienste lizenziert und konfiguriert sind, und erstelle dann eine minimale FastAPI App gemäß diesen Konventionen.
Tech Stack
pythonfastapi
Domain
backendapi
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPythonPoetry
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80