Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qharny/eduexplorer
https://github.com/qharny/eduexplorer
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/qharny/eduexplorer
- Owner: Qharny
- Created: 2024-11-01T09:50:08.000Z (19 days ago)
- Default Branch: main
- Last Pushed: 2024-11-01T13:41:03.000Z (19 days ago)
- Last Synced: 2024-11-01T14:31:28.670Z (19 days ago)
- Language: Kotlin
- Size: 97.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# EduExplorer 🎓
EduExplorer is an Android application that helps users discover universities worldwide. Using a clean and intuitive interface, users can search for universities by country and access detailed information about educational institutions globally.
## Features ✨
- **Country-based Search**: Easily find universities by entering a country name
- **Detailed Information**: Access comprehensive details about each university
- **Interactive UI**: Modern Material Design interface with smooth animations
- **Website Integration**: Direct links to university websites
- **Offline Support**: Data persistence for seamless user experience
- **Responsive Design**: Adapts to different screen sizes and orientations
## Screenshots 📱
[Place screenshots here]
## Technical Stack 🛠
- **Language**: Kotlin
- **Architecture**: MVVM (Model-View-ViewModel)
- **Dependencies**:
- Retrofit2 for API calls
- Coroutines for asynchronous operations
- LiveData for reactive data handling
- ViewModel for lifecycle management
- Material Design Components
- Navigation Component
- ViewBinding for view interaction
## Setup & Installation 📥
1. Clone the repository:
```bash
git clone https://github.com/qharny/EduExplorer.git
```
2. Open the project in Android Studio
3. Sync project with Gradle files
4. Run the app on an emulator or physical device
## API Integration 🌐
The app uses the Universities API (http://universities.hipolabs.com) to fetch university data. The API provides information such as:
- University name
- Country
- State/Province
- Domains
- Web pages
## Project Structure 📂
```
app/
├── src/
│ ├── main/
│ │ ├── java/com/example/eduexplorer/
│ │ │ ├── data/
│ │ │ │ ├── model/
│ │ │ │ ├── repository/
│ │ │ │ └── api/
│ │ │ ├── ui/
│ │ │ │ ├── adapter/
│ │ │ │ ├── viewmodel/
│ │ │ │ └── activity/
│ │ │ └── util/
│ │ └── res/
│ │ ├── layout/
│ │ ├── values/
│ │ └── drawable/
│ └── test/
└── build.gradle
```
## Architecture 🏗
The app follows the MVVM (Model-View-ViewModel) architecture pattern:
- **Model**: Represents the data and business logic
- **View**: UI elements (Activities/Fragments)
- **ViewModel**: Manages UI-related data and business logic
## Contributing 🤝
1. Fork the repository
2. Create a feature branch: `git checkout -b feature/YourFeature`
3. Commit changes: `git commit -m 'Add YourFeature'`
4. Push to branch: `git push origin feature/YourFeature`
5. Submit a Pull Request
## License 📄
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments 🙏
- Universities API for providing the data
- Material Design for UI components
- Open source community for various libraries used
## Contact 📧
- Project Link: [https://github.com/Qharny/EduExplorer](https://github.com/qharny/EduExplorer)
- Developer Email: [email protected]
## Future Enhancements 🚀
- [ ] Add favorites functionality
- [ ] Implement advanced filtering options
- [ ] Add university comparison feature
- [ ] Include user reviews and ratings
- [ ] Implement dark mode
- [ ] Add multilanguage support
- [ ] Integrate maps for university locations
- [ ] Add share functionality
---
Made with ❤️ by Kabutey Manasseh Kwame