Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
devanshagar783 authored Feb 26, 2021
1 parent 6b74ea0 commit c4bd334
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,43 @@
# rickrolled
<p align="center">
<a href="" rel="noopener">
<img width=370px height=280px src="https://github.com/devanshagar783/rickrolled/blob/main/app/src/main/res/drawable/rickmortyrepoimg.jpg" alt="Project logo"></a>
</p>
<h3 align="center">Rick Rolled</h3>

---

## 📝 Overview of project
This is an application build during the Api-digest-2021

The application uses a [_'RickAndMorty'_](https://rickandmortyapi.com) api.

On the main screen, there are _cards_ which display basic character info.

User can navigate back and forth among the different pages to view all characters.

There is a family tree for the Smith family which also shows character info upon clicking on a certain image.

#### Future Scope
We intend to add a filter feature which will allow user to search for a character just by name, species, status(DOA) etc.

Add the location and episode views.

### Installing

A step by step series of instructions that tell you how to get a development env running.

```
Clone the repository
Open the project in Android Studio
Connect the Android phone and enable USB debugging OR Connect the AVD and have it up and running
Click on run in Android Studio
```

## 🚀 Deployment

To quickly run the app on your phone, head over to Releases on right side of these page and download the .apk file for this application.

## ⚒️ Developers

- [Akshat Srivastava](https://github.com/Arsh150701)
- [Devansh Agarwal](https://github.com/devanshagar783)

0 comments on commit c4bd334

Please sign in to comment.