CoreProject Android App

Welcome to the CoreProject Android App repository! This open-source project aims to provide a modern Android app for CoreProject. The app is built using the Kivy framework and Python programming language.

• CoreProject Website
• Repository Link

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation and Setup
• Contributing
  • Contributor's Guide
  • Code Style
  • Submitting Changes
• License

Features

• List the key features of the CoreProject Android App here.

Getting Started

Follow these instructions to set up the CoreProject Android App locally on your development environment.

Prerequisites

• Python (3.10+ recommended)
• Poetry for dependency management

Installation and Setup

To set up the project, you'll need Poetry installed.

1. Clone this repository:

   git clone https://github.com/coreproject-moe/android.git
   cd android

2. Create a virtual environment (optional but recommended):

   python3 -m venv venv
   source venv/bin/activate  # On Windows: .\venv\Scripts\activate

3. Install project dependencies using Poetry:

   poetry install

4. Run the application:

   poetry run python main.py

Contributing

We welcome contributions from the community to make the CoreProject Android App better. Please follow the guidelines below for contributing.

Contributor's Guide

1. Fork the repository.
2. Create a new branch from the main branch for your changes.
3. Make your changes and ensure that your code follows the project's code style.
4. Write tests for your changes if applicable.
5. Update documentation as needed.
6. Push your changes to your forked repository.
7. Create a pull request (PR) to the main branch of this repository.

Code Style

Maintain a consistent code style throughout the project. Follow the PEP 8 guidelines for Python code.

Submitting Changes

• Your PR should have a clear title and description explaining the purpose of the changes.
• Reference any relevant issues in your PR description using the #issue_number syntax.

License

This project is licensed under the AGPL-3.0 License.