USEPA / cam-api-portal

Api for data collected to run programs designed to reduce air pollution from power plants
MIT License
5 stars 3 forks source link

Create barebones API docs card grid React component #85

Closed j-tafoya closed 2 years ago

j-tafoya commented 2 years ago

Definition of Ready

User Story

As a user visiting the API docs I want to see a grid of cards that describe each API and link to them So that I can quickly click on the card and navigate to the docs

Acceptance Criteria

Given a list of placeholder text (title and description) for now When a user visits the API docs page Then they should see a set of cards with placeholder text in a grid underneath the overview text at the top

Given a card in the grid When the card is displayed Then it should have a title, description, and "View docs" button

Given a grid of cards When the page is resized Then the cards should wrap to new rows accordingly

Development Notes

See the invision wireframe for reference. This is a simple user story without the actual API info. Another issue will be created to add the actual info.

Testing

Test Description

Verify the cards display on the page appropriately and wrap when resized.

Assumptions and Pre-Conditions

Assume a set of info about APIs

Test Data

Placeholder information

Steps to be Executed

  1. Supply a list of placeholder API info
  2. Visit the API docs page
  3. Verify the cards render in a grid and adjust according to mobile and desktop sizes

Definition of Done

j-tafoya commented 2 years ago

Include account, facilities, MDM, and emissions endpoints to start