Skip to content

GDSC-PKNU-Official/SogongSogong-front

Repository files navigation

Contributors Forks Stargazers Issues


Logo

Sogong Sogong (소공소공)
Anonymous Communication Platform for Small Business to solve the UN's SDGS No.8.

Explore the notion (Only In Korean)
View Demo · Report Bug & Request Feature · Back-End Readme


Table of Contents
  1. Introduction
  2. Getting Started
  3. Usage
  4. Structure
  5. Contributing
  6. Contact

Introduction

Summary

Sogong Sogong is an Android application which communicate anonymously.

  • Meaning of Sogong Sogong : Sogong Sogong is a combination of Korean words which means whisper(pronounced as SOGON) and abbreviation of small business owners (pronounced as SOsang-GONGin).
  • Target : Sogong Sogong is for ==small business owner and prospective entrepreneurs.== So they can talk about many things that you haven't told anyone and anywhere. The things can be stories about sales concern, rude customers and even franchise's abuse of power. Also the application supports used market that allow store transactions.
  • Effection : Because Sogong Sogong guarantees complete anonymity, it refreshes an atmosphere of small business, full of absurdity and COVID 19. And through used market, it supports easy-trade on online unlike people did legwork in the past.

Flow Chart

See Flow Chart at the following Link!

Tech Stack(Front-End)


Getting-Started

Prerequisites

To run Sogong Sogong App

  • Android 6.0(Marshmallow) at least
  • Not support iOS.

To edit file

  • Latest version of Android Studio
  • Kotlin 1.6.10

Installation

Follow the below instructions!

  1. Download the app.
  2. Participate in small and medium-sized communities through membership registration
  3. You can communicate with more diverse operators by authenticating your business number.
  4. Share your questions, hardships, and good tips.
  5. You can find out what you're interested in through hashtag.

Let's be together at Sogong Sogong, a communication channel only for small business owners!


Usage

This section explains the guidelines for how to use Sogong Sogong

* The pictures down below may differ from the actual design.
  1. In Sogong Sogong, you need business license number to sign in.
    If you don't have it, you can skip this process.
    However, service doesn't support some functions compared to members who have certified.
    Don't worry! You can regist it later.

  2. At the main page, there are several information, posts for you!
    And bottom navigation means main page, board list, notification and settings in order.

  3. If you want to enter boards to see posts, you can enter to them by touching at second bottom navigation.
    And then, see the details of post by just clicking the part.

  4. On the detail of post page, you can store it by clicking icons in your 'Liked Post' and 'Clippings'.
    In addition, you can write comments anonymously.

  5. When you want to post something, please click the floating icon at the bottom named 'Post'.
    On the writing page, you need to choose post-hashtags and write contents.
    Post-hashtags can be selected up to two from two categories.
    And posts are anonymous like comments.

  6. Please click the icon 'Sogong Sogong Board' at the second page, if you want to get official information.

  7. If you want to find posts, you can find them by hashtags in two ways.
    The first is through the search bar at the main page, second one is through 'Hastag Board' at the board list.

  8. To check new notification, you can enter through third bottom naviagtion.

  9. You can change application settings in 'My Page' at the bottom navigation on the far right.


Structure

Front-End

Directory structure

Directory sturcture could be changed.

OPEN

├── README.md
├── app/
│   ├── proguard-rules.pro
│   ├── google-services.json
│   │── .gitignore 
│   ├── build.gradle
│   └── src/
│            ├── androidTest/java/com/gdsc/sogongsogong/
│            ├── test/java/com/gdsc/sogongsogong/
│            └── main/
│                     ├── AndroidManifest.xml
│                     ├── res/
│                     └── java/com/gdsc/sogongsogong
│                             ├── App.kt
│                             ├── MainActivity.kt
│                             ├── NavViewModel.kt
│                             ├── SplashActivity.kt
│                             └── data/
│                                     └── entity/
│                                             ├── BoardReport.kt
│                                             ├── Hashtag.kt 
│                                             ├── Noti.kt 
│                                             └── Post.kt
│                                     └── remote/
│                                             ├── Api.kt
│                                             ├── ApiService.kt
│                                             └── datasource/
│                                                     ├── PostRemoteDataSource.kt
│                                                     └── PostRemoteDataSourceImpl.kt
│                             └── util/
│                                     └── FlowExtension.kt
│                             └── di/
│                                     └── dispatcher/
│                                             ├── DispatcherProvider.kt
│                                             └── DispatcherProviderImpl.kt 
│                                     └── module/
│                                             ├── DataSourceModule.kt
│                                             └── DispatcherModule.kt
│                             └── fake/
│                                     ├── FakeFactory.kt
│                                     └── SimpleApi.kt
│                             └── ui
│                                     └── base
│                                             ├── BaseActivity.kt
│                                             ├── BaseFragment.kt
│                                             ├── BaseViewHolder.kt
│                                             └── BaseViewModel.kt
│                                     └── board
│                                             ├── BoardActivity.kt
│                                             ├── BoardAdapter.kt
│                                             └── BoardViewModel.kt
│                                     └── boardlist
│                                             └── BoardListFragment.kt
│                                     └── home
│                                             ├── HomeBoardAdapter.kt
│                                             ├── HomeFragment.kt
│                                             └── InformationAdapter.kt
│                                     └── join
│                                             └── JoinActivity.kt
│                                     └── notification
│                                             └── NotificationFragment.kt
│                                     └── post
│                                             ├── PostImageAdapter.kt
│                                             └── PostImagePagerAdapter.kt
│                                     └── search
│                                             └── BoardSearchActivity.kt
│                                     └── setting
│                                             ├── SettingsContentsAdapter.kt
│                                             ├── SettingFragment.kt
│                                             └── SettingViewModel.kt
│                                     └── writepost
│                                            └── WritePostActivity.kt
├── .gitignore
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle

Screen structure

  • Screen can be divided in Main screen and Bottom navigation.

Back-End


Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create.
Any contributions you make are greatly appreciated.

  1. Request Feature yourself
  2. Fork the Project
  3. Create your Feature Branch (git checkout -b feature/#{IssueNumber})
    • ex) feature/#1
  4. Commit your Changes (git commit -m 'Issue #{IssueNumber} feat: Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/#{IssueNumber})
  6. Open a Pull Request

Contact


About

소상공인을 위한 익명 플랫폼, 소공소공

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages