Skip to content

Commit

Permalink
docs: add images
Browse files Browse the repository at this point in the history
  • Loading branch information
Veirt committed Dec 11, 2024
1 parent cf09bec commit cd0e1df
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 38 deletions.
Binary file added .github/learner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/splash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/tutor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@ The Tutortoise Android Application is developed using Kotlin Programming Languag

Tutortoise App is design to look simple, easy to use and understand, fitting with most modern apps.

[Images Here]
<center>
<img src=".github/splash.png" width="200" height="400" />
<img src=".github/login.png" width="200" height="400" />
<img src=".github/tutor.png" width="200" height="400" />
<img src=".github/learner.png" width="200" height="400" />
</center>

## Features

In Tutortoise, we focus on delivering tools and functionalities designed to enhance learning and teaching experiences. This section outlines the core aspects that make the app effective and user-friendly.

### 1. Explore and Find the Perfect Tutors
### 1. Explore and Find the Perfect Tutors

Easily search for tutors based on various criteria such as category, location, hourly rate, rating, and lesson type (online/offline). This feature allows learners to quickly narrow down the options and find a tutor that fits their specific needs.

Expand Down Expand Up @@ -42,19 +47,19 @@ Tutors can manage their schedules effectively. Tutors who accept a learner's res

## Dependencies

* [Android Material](https://github.com/material-components/material-components-android/blob/master/docs/getting-started.md)
* [CircleImageView](https://github.com/hdodenhof/CircleImageView)
* [Firebase](https://firebase.google.com/docs/android/android-play-services)
* [Flexbox](https://github.com/google/flexbox-layout)
* [Glide](https://github.com/bumptech/glide)
* [Gson](https://github.com/google/gson)
* [Kotlin Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
* [Lifecycle & LiveData](https://developer.android.com/jetpack/androidx/releases/lifecycle)
* [Logging Interceptor](https://square.github.io/okhttp/)
* [Play Services](https://developers.google.com/android/guides/setup)
* [Retrofit](https://github.com/square/retrofit)
* [Shimmer](https://github.com/facebookarchive/shimmer-android)
* [Ucrop](https://github.com/Yalantis/uCrop)
- [Android Material](https://github.com/material-components/material-components-android/blob/master/docs/getting-started.md)
- [CircleImageView](https://github.com/hdodenhof/CircleImageView)
- [Firebase](https://firebase.google.com/docs/android/android-play-services)
- [Flexbox](https://github.com/google/flexbox-layout)
- [Glide](https://github.com/bumptech/glide)
- [Gson](https://github.com/google/gson)
- [Kotlin Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
- [Lifecycle & LiveData](https://developer.android.com/jetpack/androidx/releases/lifecycle)
- [Logging Interceptor](https://square.github.io/okhttp/)
- [Play Services](https://developers.google.com/android/guides/setup)
- [Retrofit](https://github.com/square/retrofit)
- [Shimmer](https://github.com/facebookarchive/shimmer-android)
- [Ucrop](https://github.com/Yalantis/uCrop)

# Tutortoise (Local Setup)

Expand Down
55 changes: 32 additions & 23 deletions app/src/main/res/layout/activity_detail_tutor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@
android:textColor="#757575"
android:textSize="12sp"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent"/>
app:layout_constraintTop_toTopOf="parent" />

<TextView
android:id="@+id/tvTutoriesName"
Expand Down Expand Up @@ -257,27 +257,6 @@
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@id/tvTutoriesName" />

<TextView
android:id="@+id/tvCategoryName"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="4dp"
android:fontFamily="@font/montserrat_semi_bold"
android:text="@string/category"
android:textColor="@color/black"
android:textSize="14sp"
app:layout_constraintStart_toStartOf="@id/tvCategoryLabel"
app:layout_constraintTop_toBottomOf="@id/tvCategoryLabel" />

<ImageView
android:id="@+id/ivCategoryArrow"
android:layout_width="20dp"
android:layout_height="20dp"
android:src="@drawable/ic_chevron_right"
app:layout_constraintBottom_toBottomOf="@id/tvCategoryName"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="@id/tvCategoryLabel"
app:tint="#757575" />

<View
android:id="@+id/dividerCategory"
Expand All @@ -287,7 +266,37 @@
android:background="#F0F0F0"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@id/tvCategoryName" />
app:layout_constraintTop_toBottomOf="@id/groupCategory" />

<androidx.constraintlayout.widget.ConstraintLayout
android:id="@+id/groupCategory"
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:layout_constraintStart_toStartOf="@id/tvCategoryLabel"
app:layout_constraintTop_toBottomOf="@id/tvCategoryLabel">

<TextView
android:id="@+id/tvCategoryName"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="4dp"
android:fontFamily="@font/montserrat_semi_bold"
android:text="@string/category"
android:textColor="@color/black"
android:textSize="14sp" />

<ImageView
android:id="@+id/ivCategoryArrow"
android:layout_width="20dp"
android:layout_height="20dp"
android:src="@drawable/ic_chevron_right"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="@id/tvCategoryName"
app:layout_constraintBottom_toBottomOf="@id/tvCategoryName"
app:tint="#757575" />

</androidx.constraintlayout.widget.ConstraintLayout>


<!-- Student Info and Mode Section -->
<LinearLayout
Expand Down

0 comments on commit cd0e1df

Please sign in to comment.