Giter Club home page Giter Club logo

ravansa / auctionproject Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 3.0 22.61 MB

The mobile android application that users can sell and buy items by auction. The application aims to follow the best practices for modern android development (MAD). It was built with loosely coupled architecture and clean code practices in mind. (In progress)

License: MIT License

Kotlin 100.00%
clean-architecture hilt-dagger jetpack-compose kotlin-coroutines navigation-component viewmodel room-sqlite retrofit-gson android-component-archtecture signalr-socket

auctionproject's Introduction

Commercial Online Auction System

Commercial Online Auction System is a mobile android application that the users can sell their items with the auction and buy items with auction. The users can create their own auctions or participate in other users' auctions and bid on the valid auction date. After the auction ends, real-time communication is established between the highest bidder and the seller.


Platform Language Platform Language Database Kotlin Compose SQLite COAS GitHub stars

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have Android Studio installed in your machine
  • You have a Android Device or Emulator with Android Version 6.0 or above.
  • You should read SRS documentation.

Install Auction Project

Simply clone the repository from here

Table of Contents

General Information

The proposed Commercial Online Auction System (COAS) is a mobile-based application to help users buy or sell their items. They can trade whatever they want by posting an auction. This application allows users to show their items for auction. Auctioneers and bidders can register and bid on any available actions and create auctions. The application is developed in Kotlin on android and the user interface is developed using Jetpack Compose declarative UI Kit. The architecture of the application is made in accordance with the principles of Clean Architecture.



Technologies Used


COAS is an android app that attempts to use the latest libraries and tools. As a summary:
  • Minimum SDK level 21
  • Android Studio - Arctic Fox (2020.3.1)
  • Kotlin based + Coroutines for asynchronous.
  • Android Jetpack library
    • Lifecycle - dispose of observing data when lifecycle state changes
    • ViewModel - UI related data holder, lifecycle aware
    • Room Persistence - construct a database using the abstract layer
    • Navigation Component - navigate screens within the application
    • Jetpack Compose - declarative UI Kit
    • Hilt - Dagger - dependency injection
  • Architecture
    • Clean Architecture (UI Layer - Domain Layer - Data Layer)
    • Repository Pattern
  • Retrofit2 & Gson - construct the REST APIs
  • OkHttp3 - implementing interceptor, logging and mocking web server
  • Coil - loading images via HTTP
  • Lottie - for animations
  • Material-Components - Material design components
  • Firebase Cloud Storage
  • Backend - C#, .NET, MSSQL, Swagger
  • Socket, SignalR

Features

  • The users can sign up and login with Json Web Token (JWT). If token expire user need to authorize again
  • The sellers can create own auction with the desired item
  • The seller can specify details such as the auction's category, starting price, minimum increase, product images, auction start and end time when creating an auction
  • The seller can communicate with the highest bidder with real-time messaging using SignalR Socket when the auction ends
  • The seller can see past the auctions that created
  • The bidder can analyze live and ended auctions
  • The bidder can place a bid on auctions and see auction details
  • Users can search for auctions by sorting, filtering, and categories
  • The users can add any auction to favorites and save the profile information and communication preferences
  • The bidder can see other bidders' bids.

Project Status

The project is currently under development

License

MIT License

Copyright (c) [2022] [Ravan SADIGLI]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

auctionproject's People

Contributors

ravansa avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.