Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 2.44 KB

showcase_app_readme.md

File metadata and controls

94 lines (66 loc) · 2.44 KB
Raw

Readme template for Showcasing a Mobile app

Follow the below section guidelines and add the relevant information as needed.

Section 0:

  • Add relevant tags to the repo (header)
  • Add a link to the Expo app (header)

Section 1:

  • Add the logo, name of the app & description (centered)
<p align="center">
  <a href="https://react-native-training.github.io/react-native-elements/">
    <img alt="react-native-elements" src="https://user-images.githubusercontent.com/5962998/37248835-ce3dad4a-24b1-11e8-9c4b-b058c5a5e1e9.png" width="450">
  </a>
</p>

<h3 align="center">
  React Native Elements
</h3>

<p align="center">
  Cross Platform <a href="https://facebook.github.io/react-native/">React Native</a> UI Toolkit
</p>

Section 2:

  • Add a link to the demo Expo app
### [Demo - Try it on Expo](https://exp.host/@monte9/daug-mobile)

Section 3:

  • Add a description about the app
  • Add a working demo of the app using LiceCap
  • You can add a few screenshots (Optional)
## What's Daug?

**Daug is a social network for pets.**

- Your pets can **sign up or login** using their paws.
- They can **upload selfies** or **post their thoughts** for other pets to see.

![daug_demo](https://i.imgur.com/XheHhg5.gif)

Section 4:

  • Talk about the functionality of the app
  • Also mention any interesting packages used such as camera or calendar or animations etc
  • Talk about any additional functionality that you would like to implement later on
## Functionality
- Daug is a fully functioning Social Network app
- Users can Sign up & Log into the app
- Users can create a new Posts
- Users can like and comments on Posts
- Users can follow each other

Also used React Native Camera library to let the users take pictures while creating posts or upload a new profile picture.

Would like to implement Redux in the future to better manage the state. Also would like to add themeing to the app to enable light/dark modes.

Section 5:

  • Add simple Getting Started on how to clone, install and run the app locally
## Getting started


git clone git@github.com:mobilespace/daug-mobile.git

exp start

exp ios

Section 6:

  • Add a feedback or questions section
## Feedback

In case you have any feedback, feel free to open a new issues on this repo or reach out to me [**@monte9**](https://github.com/monte9).