Developer Documentation - MirRaonaq/AndroidBots GitHub Wiki

Welcome to Food Basket!

We are excited to have you join us as a contributor to Food Basket. Let's give the world free food together!

Necessary instructions to run, navigate, and contribute to our project are below.

Project Setup

  1. Download and install Android Studio for Windows or Mac here:

https://developer.android.com/studio/index.html

  1. Clone the repo:

git clone https://github.com/MirRaonaq/AndroidBots.git

  1. Open Android Studio and click "Open an existing Android Studio project"

  2. Navigate to the 'AndroidBots' folder you cloned from GitHub in step two

  3. Click the 'AndroidBots' folder and then click the 'FoodBasket' folder

  4. After entering the 'FoodBasket' folder, click open

Note: Android Studio will automatically install all necessary Gradle to run the project.

Code Structure

All frontend code will have .xml for example activity_main.xml

To navigate to our frontend code:

app -> res -> layout

All backend code will have .java for example MainActivity.java

To navigate to our backend code:

app -> java -> com.example.fatin.foodbasket

All activity_main.xml files have a connected backend java file such as MainActivity.java

activity_main3.xml is connected to Main3Activity.java and so on.

Most of the .xml and .java are labeled appropriately such as register.xml & register.java is the register page.

If in any case a .xml and .java is not labeled, it is easy to tell the purpose of the page by checking the design tab of the .xml file.

Contributing to our Project

  1. Create a new branch off of develop

  2. If you are working on an issue that is not referenced in the issue tab, create a new issue with a clear description and title

After working on the issue

  1. Create a pull request from your branch to develop, when creating a pull request, please name it according to the issue number. Also, along with the issue number, provide a clear title and description of your contributions

  2. Add a reviewer: You can add any of the members of our team to reviewer your code (MirRaonaq, KemoAli, Nazat95, wentaoch, ziangzha)