danielmonettelli / dotnetmaui-meow-app-oss

Meow is an open-source mobile application, developed in .NET MAUI, that invites you to explore a captivating assortment of adorable kitties from various breeds.

Description

In this app, users can look at cute photos of different kittens. 🐈

Table of Contents

• Description
• Table of Contents
• Instructions
• Features
• Supported platforms
• Design tool
• Publications
• 👥 Special collaborator
• 👥 Contributors
• Steps to contribute
• MIT License
• Open Source ❤

Instructions

Before running the application, it is necessary to obtain a API-KEY. To do this, visit the website https://thecatapi.com/ and click the GET YOUR API KEY button.

Then choose the FREE section and click GET FREE ACCESS.

Then provide your email address and explain why you want to use this API key. Select A PERSONAL PROJECT and finally, click on the SUBMIT button. You will receive an email with the API-KEY at the address you provided.

Now, locate the APIConstants class, copy the API-KEY and paste it into the field designated as THECAT_API_KEY_HERE. With this, you are ready to run the application.

namespace Meow.Constants;

public static class APIConstants
{
    public const string APIBaseUrl = "https://api.thecatapi.com/v1/";
    public const string APIKey = "THECAT_API_KEY_HERE";

    // ...
}

Features

• Cat image generation (Hi-res images)
• Video Streams
• Detailed breed information
• Cat facts
• Medical data

Supported platforms

	✔️
	✔️
	✔️
	✔️

Design tool

Publications

• Coming soon...

👥 Special collaborator

Bryan Oroxón

👥 Contributors

Steps to contribute

1. Fork the repo using the fork button on GitHub.

2. Clone the repo by clicking the green "Code" button and copying the HTTPS link: https://github.com/danielmonettelli/dotnetmaui-meow-app-oss.git.

3. To create a new branch, start by navigating to your cloned copy of dotnetmaui-meow-app-oss.

4. To create a new branch off of the main branch, run git checkout main.

5. To create your new branch, run git branch <your branch> and then git checkout <your branch> to switch to "new-branch".

6. You can now make your contributions here.

7. If you are done editing, you can then stage your changed files by running git add name_of_your_file or run git add . to stage all files that you have modified.

8. To commit your contributions, run git commit -m "message", where message explains the changes made.

9. Run git push origin <your branch> to push your changes.

10. Lastly, create a pull request by going to your forked repo and clicking "Compare & pull request", then clicking "Create pull request".

11. See if your changes were added!

MIT License

Copyright (c) Daniel Monettelli

Open Source ❤

It is with humility and gratitude that I offer my open source contribution to the .NET MAUI community, hoping to share a modest grain of wisdom. If you decide to use this project, please feel free to acknowledge the designer's work, contributions and dedication of all contributors involved.