Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/waffiqaziz/story-app

Story App is an Android app built for educational purposes, allowing users to post stories with photos, share locations, and discover other people's activities.
https://github.com/waffiqaziz/story-app

android appcompat camerax custom-view espresso google-maps-api kotlin mockito paging3 remote-mediator retrofit2 room-database splashscreenapi ui-testing uix unit-testing

Last synced: about 1 month ago
JSON representation

Story App is an Android app built for educational purposes, allowing users to post stories with photos, share locations, and discover other people's activities.

Host: GitHub
URL: https://github.com/waffiqaziz/story-app
Owner: waffiqaziz
License: mit
Created: 2022-04-19T17:48:55.000Z (almost 3 years ago)
Default Branch: updated-version
Last Pushed: 2024-12-19T23:30:41.000Z (about 2 months ago)
Last Synced: 2024-12-20T00:26:38.775Z (about 2 months ago)
Topics: android, appcompat, camerax, custom-view, espresso, google-maps-api, kotlin, mockito, paging3, remote-mediator, retrofit2, room-database, splashscreenapi, ui-testing, uix, unit-testing
Language: Kotlin
Homepage:
Size: 5.47 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Story App 📖

![Header](assets/logo/feature_graphic.png)
![Unit Testing](https://github.com/waffiqaziz/story-app/actions/workflows/unit_testing.yml/badge.svg)

**Story App** is an Android application developed for **educational purposes only**. It allows users
to create an account, log in, post stories with pictures from their gallery or camera, add
locations, share activities, and explore other people's stories. The app is designed for learning
and no commercial use.

## Features 🌟

- **Create Account**: Sign up and join the app community.
- **Login**: Securely log in to your account.
- **Post a Story**: Share your stories with a title, description, and pictures from the gallery or
camera.
- **Share Location**: Add location to your posts so others can see you on the map.
- **Browse Other Stories**: Discover and engage with stories posted by other users.

## Installation 🛠️

Follow these steps to install the app on your Android device or emulator:

1. **Clone the repository**:
```bash
git clone https://github.com/waffiqaziz/story-app.git
```
2. Open in Android Studio: Open the project in Android Studio.
3. Sync Gradle Files: Android Studio will automatically sync the necessary Gradle files.
4. Setup your `MAPS_API_KEY`, follow this
instruction [here](https://developers.google.com/maps/documentation/android-sdk/get-api-key).
If you get an error message in logcat like something like below, it means you haven't set up
your `MAPS_API_KEY`
```logcat
Authorization failure. Please see ....
In the Google Developer Console ....
Ensure that the "Maps SDK for Android" is enabled.
Ensure that the following Android Key exists:
API Key: DEFAULT_API_KEY
```
(Optional) Custom your map style and
edit [my_map_style.json](app/src/main/res/raw/my_map_style.json). For
reference [here](https://mapstyle.withgoogle.com/) and [here](https://snazzymaps.com/).
5. Run the App: Select a physical device or emulator, and click the "Run" button in Android Studio.

## Screenshots 📸

### Light Mode

Splash Screen
SignIn Page
Register Page
Main Page
List Page
Add Post Page
Map Page

### Night Mode

Splash Screen
SignIn Page
Register Page
Main Page
List Page
Add Post Page
Map Page

## Technologies Used 🛠️

- Platform: Android (Kotlin)
- UI Framework: Android XML for layout designs
- Database: Room database (Paging3 with RemoteMeditor)
- Location Services: Google Maps API (for location sharing)
- Networking : Retrofit
- Testing: Junit, mockito, espresso

## Terms of Use 📜

Educational Use Only
This app is built solely for educational purposes, and by using it, users agree to the following
terms:

1. Non-commercial Use: Story App is not to be used for any commercial activities.
2. Third-party API Use: The API is provided from an external source and users should acknowledge
that it is for learning purposes only.
3. User Content: Users are responsible for the stories they post. No inappropriate, offensive, or
illegal content is allowed.
4. Privacy: Users should avoid sharing any personal, sensitive, or private information within the
app.
5. Non-liability: The app developer is not liable for any misuse of the API or user-generated
content shared through the app.

## How to Contribute 🤝

Please read this [page](CONTRIBUTING.md).