Skip to content

CharlesJUDITH/woof-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chihuahua Woof API

Introduction

Welcome to the Chihuahua Facts API! This Flask-based API provides users with fun and interesting facts about Chihuahuas, accompanied by delightful, randomly selected Chihuahua images. It's perfect for dog lovers and those looking to brighten their day with some cute canine content.

Installation

To get started with the Chihuahua Facts API, follow these steps:

  1. Clone the repository:

    git clone https://github.com/CharlesJUDITH/woof-api.git
    
  2. Navigate to the project directory:

    cd woof-api
    
  3. Install the required packages:

     pip install -r requirements.txt
    

Running the API

To run the API locally, execute:

python app.py

The API will start on http://127.0.0.1:5000/. You can access the Chihuahua facts endpoint at http://127.0.0.1:5000/woof.

Usage

Visit http://127.0.0.1:5000/woof in your browser or use a tool like curl to get a random Chihuahua fact and image:

curl http://127.0.0.1:5000/woof

Contributing

Contributions to the Chihuahua Facts API are welcome! Please feel free to submit pull requests or open issues to discuss proposed changes or enhancements.