Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaronrojas32/climo
Climo is an minimalist open source wether app.
https://github.com/aaronrojas32/climo
android android-app androidstudio java weather weather-app
Last synced: 28 days ago
JSON representation
Climo is an minimalist open source wether app.
- Host: GitHub
- URL: https://github.com/aaronrojas32/climo
- Owner: aaronrojas32
- License: mit
- Created: 2024-11-22T21:44:18.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-17T11:35:28.000Z (about 1 month ago)
- Last Synced: 2024-12-23T21:16:49.486Z (28 days ago)
- Topics: android, android-app, androidstudio, java, weather, weather-app
- Language: Java
- Homepage: https://aaronrojas32.github.io/Climo/
- Size: 435 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Climo**
Climo is a minimalist, open-source weather app designed to provide accurate weather updates in a clean and simple interface. Developed using **Android Studio** with **Java** and powered by [WeatherAPI](https://www.weatherapi.com/), Climo is perfect for those who appreciate functionality without unnecessary complexity. 🌦️
---
## **Features**
- 🌍 Get the current weather for any city worldwide.
- 🧭 Clean and intuitive user interface.
- ⚡ Lightweight and optimized for modern devices.
- 🔑 Built-in support for easy integration with WeatherAPI keys.
---
## **For Contributors & Developers**
Welcome to Climo! Thank you for your interest in contributing to this project. To ensure privacy and API efficiency, you need to obtain your own API key from [WeatherAPI](https://www.weatherapi.com/) using their **Free Plan**.
### **How to Use Your WeatherAPI Key**
1. Create a file `apikeys.xml` file under the directory `res/values/`.
2. Replace the placeholder `` with your WeatherAPI key:
```xml
YOUR_API_KEY
```
3. Save the file and run the app in your preferred Android Virtual Device.
---
### **Android Virtual Device (AVD) Recommendation**
For development and testing purposes, the app has been optimized for:
- **Device:** Pixel 9
- **API Level:** 33
- **Android Version:** Android 13 ("Tiramisu")
However, Climo is designed to run on any Android device with an API **greater than or equal to 24** (Android 7.0 "Nougat").
---
### **How to Contribute to Climo**
We are excited to have you on board! Here's how you can contribute to Climo:
1. **Fork the Repository**
Navigate to the [Climo GitHub Repository](https://github.com/aaronrojas32/Climo), and click on **Fork**. Clone your forked version locally:
```bash
git clone [email protected]:/Climo.git
```
2. **Work on Issues**
Browse through the [Issues](https://github.com/aaronrojas32/Climo/issues) tab or create a new one. Assign yourself to an issue if you plan to work on it.
3. **Make Changes Locally**
Open the project in your IDE (we recommend [Android Studio](https://developer.android.com/studio)) and make your changes.
4. **Submit a Pull Request (PR)**
Push your changes to your fork, and open a [Pull Request](https://github.com/aaronrojas32/Climo/pulls). Ensure your PR references the relevant issue.
5. **Get Reviewed & Merged**
Your PR will be reviewed by maintainers. If approved, it will be merged into the main branch.
6. **Show Some Love**
Leave a ⭐ on the [GitHub repository](https://github.com/aaronrojas32/Climo) if you like the project!
---
## **For Users**
Hello and welcome to **Climo**! 🌦️ This app is your personal weather assistant, offering real-time updates for any city around the globe.
### **How to Get Started**
1. Download the app from the [Releases](https://github.com/aaronrojas32/Climo/releases) page.
2. Enter the name of your city and tap **"Consultar Clima"**.
3. View accurate weather details in an instant!
### **System Requirements**
- **Android Version:** 7.0 (API 24) or higher.
- Internet connection required to fetch weather data.
---
## **Acknowledgments**
Special thanks to:
- [WeatherAPI](https://www.weatherapi.com/) for providing the weather data.
- The open-source community for inspiration and support.
---
## **License**
This project is licensed under the MIT License. Feel free to use, modify, and distribute it in accordance with the terms of the license. See the [LICENSE](https://github.com/aaronrojas32/Climo/blob/main/LICENSE) file for details.
---