bcgov/wps

CFFDRS API: Hello World

Aberta

#2.275 aberto em 14 de set. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Python (10 forks)auto 404
4RefinementGood First IssueTask

Métricas do repositório

Stars
 (65 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Explore a estrutura do repositório existente para encontrar microsserviços semelhantes e entenda os padrões de configuração, teste e implantação do FastAPI usados no GitHub Actions. Identifique como outros serviços são licenciados e configurados e, em seguida, crie um aplicativo FastAPI mínimo seguindo essas convenções.
Pilha de tecnologia
pythonfastapi
Domain
backendapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPythonPoetry
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80