“Antiqueruby - Material Design” Documentation by “Alian Software” v1.0


“Antiqueruby - Material Design”

Created: October 2017
By: Alian Software
Email: support@aliansoftware.net

Thank you for purchasing our code. If you have any questions that are beyond the scope of this help file, please feel free to email via our user page contact form here. Thanks so much!

Table of Contents


Opening project in Android Studio - top

Android Studio project is in folder "Antiqueruby". Select "Open an Existing Android Studio project". After that, find downloaded folder from codecanyon, and find folder "Antiqueruby".

Wait few moments for studio to finish synchronizing and building and after that you are free to run “Antiqueruby” project. If there is any problem in syncing, then clean the project from ‘Build > Clean Project’ and then make project from ‘Build > Make Project’


Introduction - top

This application consists of collection of screens like Drawers, Social, Sign In, Sign Up, Profile, and Walkthrough. These screens are found commonly in day to day apps. You can use code from here by just copy/pasting it into your project.

Project Structure

In the main project, you will have MainActivity which implements native Android left menu (Navigation Drawer). In MainActivity you have 6 left navigation items : Drawers, Social, Sign In, Sign Up, Profile, and Walkthrough. Clicking on each item will open their particular fragments located in main Fragment folder. Each fragment has a list of screens which are placed in card view. To see what fragment is used for what, you can refer to the name of that fragment. We have given names to fragments that are equal to the item they represent ending with ~Fragment.java in the location is "app > java > com.aliansoftware.antiqueruby > Fragment > DrawerFragment.java"

All the projects consists of several sub folders e.g. adapter, pojo, fragments, and view. The java files are separated in their particular folder, according to their types for ease of understanding the structure.

The Adapter folder comprises of various adapters like BaseExpandableListAdapter, RecyclerView.Adapter, ArrayAdapter, ArrayAdapter, PagerAdapter, etc.

The pojo folder mainly consists of the getter and setter methods used in the activities and the fragments.

Similarly the fragment folder consists of the fragments used in the screens. The view folder consists of custom views and image view used in the screens.

Related Files:

Fonts

Several Custom Fonts are used in the project to give a nice look and feel to the screens. These fonts can be found in assets package from the project. All the fonts are in .ttf format.

The fonts should be copied in the assets package of your project. Assets package can be created in your project by, Android Studio >File> New > Folder > Assets Folder. In that package place the fonts folder which is provided in our project location.

One example of a font is "app > assets > fonts > SF-UI-Display-Regular.ttf".

After that, we have implemented the fonts in our screen by using Typeface and setTypeface class in the java files.


Foreign projects - top

This app uses many projects from GitHub. All of them have licence that allows us to import the project in our project and then sell it on Envato.

We have listed all the foreign projects that are used in this project with a link to it. If you have any questions regarding foreign projects, don't hesitate to email us. We will help you.

Projects we used for this project are:

Every project from GitHub is imported into workspace and converted to library project, So, if you would like to use features from these GitHub projects, you can import them directly into your own project gradle as explained in the above links.

Note : Above method requires active internet connection

Duo Navigation Drawer is imported as library project into the main project (duo-navigation drawer). By this way you can customize the library from the project as per requirement. You can import that one by New > Import Module in Android Studio and select the duo navigation drawer folder from our project. Its location is "antiqueruby > duo-navigation-drawer".

Note : Above method requires active internet connection

The other way to import Duo Navigation Drawer library is by compiling the library directly in the gradle from the above given link of this library. But this way , you cannot customize the library as per your need.


Drawers - top

For creating drawers, we have used libraries like recyclerview, cardview, circleimageview, expanding view, bottom bar from foreign projects. The Navigation drawers of all the screens is kept open by default on opening of the screen.

  1. To get Drawers in your project ,You just have to copy the Drawer folder from java folder and paste it in your project .
  2. Copy the related .xml files and drawable files which are listed below.
  3. Copy activities declaration in Drawer section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related Files:


Profiles - top

For creating profiles, we have used libraries like recyclerview, cardview, circleimageview, bottom bar from foreign projects. Moreover, these screens have animations which can be found in app/res/anim/ location in the project.

  1. To get Profile Screens in your project ,You just have to copy the Profile folder from java folder and paste it in your project .
  2. Copy the related .xml files, anim folder and drawable files which are listed below.
  3. Copy activities declaration in Profile section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related files:


Sign In - top

For creating sign in screens, we have used libraries like glide and picasso from foreign projects to load images into the layout. These screens consists of various attractive login buttons like facebook and twitter login buttons.

  1. To get SignIn Screens in your project ,You just have to copy the SignIn folder from java folder and paste it in your project .
  2. Copy the related .xml files ,anim file and drawable files which are listed below.
  3. Copy activities declaration in SignIn section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related files:


Sign Up - top

For creating sign up screens, we have used libraries like glide and picasso from foreign projects to load images into the layout. These screens consists of various attractive login buttons like facebook and twitter login buttons.

  1. To get SignUp Screens in your project ,You just have to copy the SignUp folder from java folder and paste it in your project .
  2. Copy the related .xml files ,anim file and drawable files which are listed below.
  3. Copy activities declaration in SignUp section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related files:


Social - top

For creating social screens, we have used libraries like glide, picasso, recyclerview, card view, circle image view, bottom bar, bottom navigation from foreign projects. These screens also have various animations on recycler view which can be found in anim folder from the project.

  1. To get Social Screens in your project ,You just have to copy the Social folder from java folder and paste it in your project .
  2. Copy the related .xml files ,anim file and drawable files which are listed below.
  3. Copy activities declaration in Social section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related files:


Walkthrough - top

For creating walkthrough screens, we have used libraries like glide, picasso, recyclerview, card view, circle image view, the4thdimension - android utils , nineoldandroids from foreign projects. These screens have viewpager implemented in the design to give desired effects. Some of the screens also have animations which are used from the above given libraries.

  1. To get Walkthrough Screens in your project ,You just have to copy the Walkthrough folder from java folder and paste it in your project .
  2. Copy the related .xml files ,anim file and drawable files which are listed below.
  3. Copy activities declaration in Walkthrough section from our manifests file and paste in your manifests file.
  4. If you want to use themes any styles, you can copy and paste it from our styles folder.

Note : To use fonts make sure you have copied all the fonts files (.ttf) from assets folder

Related files:


Once again, thank you so much for purchasing this app. As we said at the beginning, we'd be glad to help you if you have any questions relating to this app. No guarantees, but we'll do our best to assist.

Alian Software

Go To Table of Contents