Giter Club home page Giter Club logo

catbreeds's Introduction

Cat Breeds

This is a demo App that lists basic information of some cat breeds.

Getting Started

Configure API

Under the folder src/utils/api add a file api.config.json with the following structure:

{
	"url": "https://api.thecatapi.com/v1/breeds",
	"headers": {
		"X-API-KEY": "[custom-api-key]"
	}
}

catbreeds's People

Contributors

estidlore avatar

Watchers

 avatar

catbreeds's Issues

Setup testing-library

Description

As a Developer
I need The ability to test the code
So that Can detect some bugs easier

Details

  • Use @testing-library/jest-native & @testing-library/react-native

Acceptance criteria

Given A simple test with testing-library for the App file
When The test script is executed
Then The test success

Add view Cats

Description

As a User
I need The ability to list cats from the api with their information
So that Can see their individual characteristics

Details

  • Use Cards with cat's photo, name, breedName, origin and intelligence
  • Diagram:
    image

Acceptance criteria

Given The app is active
When The Cards are rendered
Then The cats information is displayed similar to the diagram

Add base components

Description

As a Developer
I need The ability to reuse components
So that The UI elements are easier to add and keep consistent

Details

  • Card
    image

Acceptance criteria

Given A reusable component is used
When The component is active on screen
Then The content provided is shown accurately

Add util to get cats information

Description

As a Developer
I need To request services from the cat api
So that Can show the cats information in the app

Details

Acceptance criteria

Given The api information is fetched
When The result is verified
Then Its content is a list with information similar to the expected Cat model

Set format rules

Description

As a Developer
I need The ability to follow a standard code format
So that The codebase is easy to read and maintain

Details

  • Use prettier

Acceptance criteria

Given New changes are ready to submit
When The script "npm run format" is executed
Then The code added/changed is well formated

Add readme with getting started intructions

Description

As a New Developer
I need The ability to follow intructions to setup the project's environment
So that Can start working in the project as soon as possible

Details

  • How to configure API

Acceptance criteria

Given A new developer with no knowledge about the project
When They follow the README instructions
Then They is ready to start working in the project

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.