bcgov/wps

CFFDRS API: Hello World

Open

#2,275 opened on Sep 14, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (10 forks)auto 404
4RefinementGood First IssueTask

Repository metrics

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

Description

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 direction
Explore the existing repository structure to find similar microservices and understand the FastAPI setup, testing, and deployment patterns used in GitHub Actions. Identify how other services are licensed and configured, then create a minimal FastAPI app following those conventions.
Tech stack
pythonfastapi
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonPoetry
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80