Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 2.52 KB

GET_STARTED.md

File metadata and controls

70 lines (54 loc) · 2.52 KB

🚀 Getting Started

Code Guidelines

CuteApps currently don't have alot of guidelines, but it is best if you follow the few ones they have such as :

  • Clutter-free experience : This is self explanatory, avoid adding elements if un-needed, two example could be :
    • flashing music icon : The music icon in the searchbar flashes red, indicating that it is clickable / has an action related to it
    • the restart button, the seek to previous automatically becomes one 10 seconds in the song instead being a whole new button which brings us to the next guideline :
  • Make things clear : If you are adding a feature, make sure it is clear of what it does, clear text/description, accurate icon
  • Landscape : CuteApps MUST be fully compatible with landscape mode, if you are adding any screen, make sure it has a landscape variant, otherwise your PR will be ignored
  • Creativity : This isn't mandatory, but if you are designing a screen or something else, be creative ! Try things no other apps has before, be unique ! Remember, failure is just a step closer to perfection !

Prerequisites

  • Android Studio (latest version recommended)
  • Java Development Kit (JDK) 11 or higher
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/sosauce/CuteMusic.git
cd CuteMusic

  2. Open the project in Android Studio:

    • Open Android Studio.
    • Select Open an existing project.
    • Navigate to the CuteMusic directory and select it.

  3. Build the project:

    • Click on Build in the top menu.
    • Select Make Project and ensure there are no errors.

  4. Run the app:

    • Connect an Android device or use an emulator.
    • Click on Run in the top menu.
    • Select your device and click OK.

Contributing

  1. Fork the repository:

    • Click the Fork button on the top right of the repository page.

  2. Create a new branch:

    git checkout -b feature/YourFeatureName

  3. Make your changes:

    • Implement your feature or bug fix.
    • Ensure your code follows the project's coding standards.

  4. Commit your changes:

    git add .
git commit -m "Add feature: YourFeatureName"

  5. Push to your fork:

    git push origin feature/YourFeatureName

  6. Create a Pull Request:

    • Go to the original repository.
    • Click on Pull Requests and then New Pull Request.
    • Select your branch and submit the pull request.

Thank you to anyone taking their time to contribute and improve the app ❤️!!!