WordPress Android Client (WAC) is an open-source project aimed at providing a convenient mobile interface for WordPress website users on Android devices. This README file serves as a guide for contributors, users, and anyone interested in the project.
WAC enables users to perform various tasks related to their WordPress websites such as reading posts, managing comments, and much more, all from the convenience of their Android smartphones or tablets. The project is built with usability, performance, and security in mind.
- Reading Blog Posts: Read posts directly from your Android device.
- Comment Moderation: Manage comments on your WordPress site on the go.
- Android Compose: Utilize Android Compose for programming.
- Retrofit: Use Retrofit for API requests.
- Hilt DI: Employ Hilt for dependency injection.
To get started with WordPress Android Client, follow these steps:
-
Clone the Repository: Clone this repository to your local machine using
git clone. -
Add Base URL: In the root folder of the project, add a file named 'values.txt' and write a line like 'BASE_URL="http://yourwordpresssite.com/wp-json/wp/v2/";'
-
Build the Project: Build the project using Android Studio or your preferred IDE.
-
Configure: Set up the necessary configurations, including the username and password if needed.
-
Run the App: Run the application on your Android device or emulator.
Contributions to WordPress Android Client are welcome and encouraged. If you want to contribute, follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix.
-
Make your changes and ensure they are well-tested.
-
Submit a pull request detailing your changes.
-
Wait for feedback or approval from the project maintainers.
WordPress Android Client is licensed under the MIT License. See the LICENSE file for details.
For support or inquiries, please open an issue on GitHub.