bcgov / bcgov/wps

CFFDRS API: Hello World

Open
#2,275 1 comment 0 reactions 0 assignees View on GitHub
4Refinement Good First Issue Task
Dominant language
Python
Stars
65
Forks
11
Avg merge
21h 25m
Merged PRs (30d)
70

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

Open the contributing guide

Research direction

Start by reviewing the repository's existing Python and GitHub Actions structure, then identify where a Poetry-managed FastAPI service and its production deployment belong. Confirm the GPL licensing requirement and define the production target before implementation. Done means a FastAPI app responds with "Hello world" and the service deploys to production through GitHub Actions.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, github-actions, python
Domain
api, backend, cloud, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.