Skip to content

bojanradjenovic/cats-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cats-api

This API was made for Hack Club's RaspAPI.

  • Flask API for viewing/uploading/deleting cat images
  • Uses JWT authentication
  • Swagger documentation (Flask-RESTX)
  • Stores user data using SQLite

You can check out the live API demo here.
I've also made a demo website which utilises the API. You can check out the live demo or access the repository.

Installation

  1. Clone the repository
    git clone https://github.com/bojanradjenovic/cats-api.git
  2. Navigate to the repository directory
    cd cats-api
  3. Make a virtual environment (recommended)
  4. Install the required dependencies
    pip install -r requirements.txt
  5. Fill out the configuration file (rename to config.json afterwards)
  6. Run the app!

Swagger API Documentation

Once the server is running, you can access the API documentation at:

http://localhost:5000

or at the address you specified.

About

API for cat images in Flask

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages