Skip to content

Instantly share code, notes, and snippets.

@daniellevass

daniellevass/starting_library_project_AS.md

Last active August 30, 2020 00:48
Download ZIP

Revisions

  1. daniellevass revised this gist Mar 29, 2015. 1 changed file with 10 additions and 0 deletions.
    10 changes: 10 additions & 0 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -53,6 +53,16 @@ You'll also need to remove `applicationId` in `defaultConfig` before synchronisi
    ## Add Library project into useful app


    ####1. settings.gradle

    ![Imgur](http://i.imgur.com/qYns5V3.png)



    ####2. build.gradle

    ![Imgur](http://i.imgur.com/gKMdtvA.png)
    >
    ## Conclusion

  2. daniellevass revised this gist Mar 29, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    # Getting Started with a library project in Android Studio

    So we're working on creating Android Material Awesome, a library which will hopefully incorperate the benefits of Material Design, Twitter's Bootstrap, and FontAwesome. What we really wanted is a **project other people can easily include into their projects using gradle dependencies**. These are the steps we took to get started in Android Studio (version 1.1).
    So we're working on creating Android Material Awesome, a library which will hopefully incorperate the benefits of Material Design, Twitter's Bootstrap, and FontAwesome. What we really wanted is a **project other people can easily include into their projects using gradle dependencies**. To do this we needed to create a standalone library project so we could make it as lightweight as possible for including as a dependency, and a sample app that would use it for testing. These are the steps we took to get started in Android Studio (version 1.1).

    ## Create Projects

  3. daniellevass revised this gist Mar 29, 2015. 1 changed file with 9 additions and 8 deletions.
    17 changes: 9 additions & 8 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -8,22 +8,23 @@ The first thing we needed to do was to create **two** new projects, with all the

    ## Fix Up Library Project

    1. Rename module in Android Studio
    ####1. Rename Module

    Initially we'll focus on our library project. Annoyingly Android Studio automatically creates you a module called `app`. Modules really should be uniquely named, so you'll need to right click on the module name, click `refactor` and rename to something useful. We called ours `library`.

    2. Rename folder in Finder / File Explorer
    3. drag build.gradle into Android Studio
    4. Synchronise
    ####2. Rename Folder

    Unfortunately, this doesn't fully rename the root folder. So using Finder (OS X) or File Explorer (Windows), you'll need to navigate to the module folder. Rename it to match what you named your module you named it e.g. `library`.

    ![Imgur](http://i.imgur.com/GtKnVkF.png)
    > Android Studio calls my module library, but Finder still says app
    Initially we'll focus on our library project. Annoyingly Android Studio automatically creates you a module called `app`. Modules really should be uniquely named, so you'll need to right click on the module name, click `refactor` and rename to something useful. We called ours `awesomematerial`.

    Unfortunately, this doesn't fully rename the root folder. So using finder or file explorer, you need to navigate to the module folder. Rename it to whatever you named it e.g. `awesomematerial`.
    ####3. Drag build.gradle into Android Studio

    This'll break your project! To fix it, you need to go back to Android Studio, and open the build.gradle for the module. It'll have a little warning at the top asking you to add it to the project. Click this and wait for gradle to synchronise again! All your files should magically reappear again!

    =====
    ![Imgur](http://i.imgur.com/SgoMGHh.png)
    > Drag the highlighted file back into Android Studio
    ####4. Synchronise

  4. daniellevass revised this gist Mar 29, 2015. 1 changed file with 4 additions and 5 deletions.
    9 changes: 4 additions & 5 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -17,9 +17,6 @@ The first thing we needed to do was to create **two** new projects, with all the




    6. ssss

    Initially we'll focus on our library project. Annoyingly Android Studio automatically creates you a module called `app`. Modules really should be uniquely named, so you'll need to right click on the module name, click `refactor` and rename to something useful. We called ours `awesomematerial`.

    Unfortunately, this doesn't fully rename the root folder. So using finder or file explorer, you need to navigate to the module folder. Rename it to whatever you named it e.g. `awesomematerial`.
    @@ -28,10 +25,12 @@ This'll break your project! To fix it, you need to go back to Android Studio, an

    =====

    ####4. Synchronise

    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!
    You should see a yellow/gold banner appear at the top of your file, click it to add file to your project and wait for Android Studio to synchronise. Once it's done, you should see all your files have magically reappeared again!

    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > click the yellow/gold banner at the top to add file to project and synchronise
    ####5. Make Android Library

  5. daniellevass revised this gist Mar 29, 2015. 1 changed file with 5 additions and 0 deletions.
    5 changes: 5 additions & 0 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -32,6 +32,9 @@ This'll break your project! To fix it, you need to go back to Android Studio, an
    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!

    ####5. Make Android Library

    Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`
    @@ -40,6 +43,8 @@ to say:

    `apply plugin: 'com.android.library'`

    ####6. Remove applicationId

    You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.

    ![Imgur](http://i.imgur.com/UEucq9C.png)
  6. daniellevass revised this gist Mar 29, 2015. 1 changed file with 10 additions and 7 deletions.
    17 changes: 10 additions & 7 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -14,13 +14,7 @@ The first thing we needed to do was to create **two** new projects, with all the
    2. Rename folder in Finder / File Explorer
    3. drag build.gradle into Android Studio
    4. Synchronise
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`



    @@ -32,12 +26,21 @@ Unfortunately, this doesn't fully rename the root folder. So using finder or fil

    This'll break your project! To fix it, you need to go back to Android Studio, and open the build.gradle for the module. It'll have a little warning at the top asking you to add it to the project. Click this and wait for gradle to synchronise again! All your files should magically reappear again!

    =====


    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!
    Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`

    6. You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.
    You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.

    ![Imgur](http://i.imgur.com/UEucq9C.png)
    > The end library build.gradle file
  7. daniellevass revised this gist Mar 29, 2015. 1 changed file with 11 additions and 6 deletions.
    17 changes: 11 additions & 6 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -14,6 +14,17 @@ The first thing we needed to do was to create **two** new projects, with all the
    2. Rename folder in Finder / File Explorer
    3. drag build.gradle into Android Studio
    4. Synchronise
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`



    6. ssss

    Initially we'll focus on our library project. Annoyingly Android Studio automatically creates you a module called `app`. Modules really should be uniquely named, so you'll need to right click on the module name, click `refactor` and rename to something useful. We called ours `awesomematerial`.

    @@ -24,13 +35,7 @@ This'll break your project! To fix it, you need to go back to Android Studio, an
    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`

    6. You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.

  8. daniellevass revised this gist Mar 29, 2015. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -9,6 +9,8 @@ The first thing we needed to do was to create **two** new projects, with all the
    ## Fix Up Library Project

    1. Rename module in Android Studio


    2. Rename folder in Finder / File Explorer
    3. drag build.gradle into Android Studio
    4. Synchronise
  9. daniellevass revised this gist Mar 29, 2015. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -22,15 +22,15 @@ This'll break your project! To fix it, you need to go back to Android Studio, an
    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`

    6. You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.
    6. You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.

    ![Imgur](http://i.imgur.com/UEucq9C.png)
    > The end library build.gradle file
  10. daniellevass created this gist Mar 29, 2015.
    44 changes: 44 additions & 0 deletions starting_library_project_AS.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,44 @@
    # Getting Started with a library project in Android Studio

    So we're working on creating Android Material Awesome, a library which will hopefully incorperate the benefits of Material Design, Twitter's Bootstrap, and FontAwesome. What we really wanted is a **project other people can easily include into their projects using gradle dependencies**. These are the steps we took to get started in Android Studio (version 1.1).

    ## Create Projects

    The first thing we needed to do was to create **two** new projects, with all the default settings (Blank Activity etc). One for our sample app, and one for our library. We added both of ours into the same GitHub repo, however you can save them wherever you like.

    ## Fix Up Library Project

    1. Rename module in Android Studio
    2. Rename folder in Finder / File Explorer
    3. drag build.gradle into Android Studio
    4. Synchronise

    Initially we'll focus on our library project. Annoyingly Android Studio automatically creates you a module called `app`. Modules really should be uniquely named, so you'll need to right click on the module name, click `refactor` and rename to something useful. We called ours `awesomematerial`.

    Unfortunately, this doesn't fully rename the root folder. So using finder or file explorer, you need to navigate to the module folder. Rename it to whatever you named it e.g. `awesomematerial`.

    This'll break your project! To fix it, you need to go back to Android Studio, and open the build.gradle for the module. It'll have a little warning at the top asking you to add it to the project. Click this and wait for gradle to synchronise again! All your files should magically reappear again!

    ![Imgur](http://i.imgur.com/XfkXOU8.png)
    > Drag your build.gradle file back into Android Studio and click the yellow/gold banner at the top to add to your project. All your files should magically reappear again!
    5. Whilst you still have your `build.gradle` file open, you'll need to change the first line :

    `apply plugin: 'com.android.application'`

    to say:

    `apply plugin: 'com.android.library'`

    6. You'll also need to remove `applicationId` in `defaultConfig` before synchronising again.

    ![Imgur](http://i.imgur.com/UEucq9C.png)
    > The end library build.gradle file
    ## Add Library project into useful app



    ## Conclusion

    Now you can create all the library projects you want to and use them in any of your other apps! We'll probably write another post depending on how hard it is to publish our library into bintray ( https://bintray.com/howbintrayworks )