Skip to content

A project to improve my skills with API requests, reactive UI, and HaxeFlixel

License

Notifications You must be signed in to change notification settings

JBB248/CatGallery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

menu-preview

A simple app that stores and displays photos and information about cats. Photos are downloaded within the app from TheCatAPI.

This is a practice project I challenged myself with to improve my work efficiency, and my skills with HaxeFlixel, reactive UI, and API requests.

Unfortunately, I cannot distribute an executable version, but the instructions to build it yourself are simple (and listed below).

Building

If you want to build your own copy or even create your own version, the steps are simple:

  • First: Download the source code or clone this repository (the latter requires git)

  • Second: Download and install Haxe

  • Third: Follow the instructions to install HaxeFlixel

  • Fourth: If you aren't going to use Neko, you'll need to set lime up for your OS

  • Fifth: While this project will work without an api key to TheCatAPI, it won't be nearly as cool.

    • If you're okay without a key, just disable the USE_API flag on project.xml by commenting out or deleting the line
    <define name="USE_API">
    • If you do want to use a key, you must first get one from here. Then make a new file in the src folder called Keys.hx. Inside it, paste the following code, replacing YOUR_KEY_HERE with the key you recieved from TheCatAPI in an email:
    package;
    
    class Keys
    {
        public static var CAT_API_KEY:String = "YOUR_KEY_HERE";
    }

    WARNING: Make sure you do not accidentally reveal your API key! Someone can abuse it without you knowing! TheCatAPI is pretty lenient with theirs, but it still should be avoided at all costs!

Note:

This is built with Neko and Windows in mind. I do not have the means to test on Mac or Linux, so those builds may not function as expected. Html5 definitely doesn't work 😅

If you have any questions, leave them in the discussions tab.

Credits

About

A project to improve my skills with API requests, reactive UI, and HaxeFlixel

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages