thisissvikas/shop-keeper

shop-keeper

A simple, self explanatory shop management application.

This is a self-explanatory shop management application that supports end-to-end management of everything that a Shopkeeper needs to deal with on a daily basis.

Problem Statement:

• Shop owners need to pay and get a software created for management of daily tasks.
• Smaller scale shops who cannot afford that, are still not digitalized.
• Lack of automated stock management.
• Unavailibilty of a self customizable and self explanatory software that needs almost no expertise to customise and bring into use.

Features

• Simple and self-explanatory shop management application
• Interactive help to get app customised and running.
• No need of software expertise.
• Zero cost digitalization for shops of all scales.

Additional Features

• User facing app.
• Self service for stock checking and purchase.

High Level Architecture - Basic Version:

shop-keeper's Issues

Product Management Service - Deployment

Problem Statement

Decide and create a deployment mechanism for product management service.

Acceptance Criteria

• Deployment Mechanism finalized
• Deployment Mechanism implemented
• Product Management Service deployed and ready for consumption

child of: #2

Product Management Service - System Design

Problem Statement

Create a design document for Product Management Service mentioning the technology/framework choices and high-level approach.

Acceptance Criteria

• Design Docment Created
• Design Docment Approved
• API Spec Created & Approved
• All guidelines are followed.

child of: #2

Product Management Service - Testing

Problem Statement

Write Unit & Integration test cases for the code as applicable.

Acceptance Criteria

• Unit Testing
• Acceptable Code Coverage
• Integration tests if applicable

child of: #2

Tech Stack & Standards

Tech Stack

• MicroService Framework: Spring Boot
• Backend Coding Language: Java
• UI Framework: React
• Database Technologies:
• Messaging Queues:
• Analytics Tools:
• Testing Framework:
• Code Coverage: Jacoco
• Deployment Strategies:

Standard Guidelines

Database Technologies

1. Make sure that we are not having to manually create/update any tables. Suggestion: Explore Flyway
2. No in-memory databases allowed for storage of persistent data. The data should not be lost in any case.
3. No Native Queries to be used unless that is the only choice. Since we are using Spring Boot, the ORM layer should be taking care of that. Suggestion: Explore Spring Data JPA.
4. Follow all applicable normalization standards.

API Spec

1. OpenApi Specification will be used as the standard for writing this.

Unit/Integration Testing

1. Use Test Containers to run DB integration tests.

Note: This is going to be updated iteratively and at the end of the v1.0 this will become a part of Readme for the project.

Product Management Service - Implementation

Problem Statement

Implement the approved design for Product Management Service.

Acceptance Criteria

• Ability to do CRUD operations for Products
• Ability to do advanced operations as per the requirement of the project
• All guidelines are followed

child of: #2

Product Management Service

Product Management Service

Problem Statement

Create a product management service that deals with the complete management of the product resource.

Acceptance Criteria

• Ability to do CRUD operations
• Ability to do advanced operations as per the requirement of the project

Product Management Service - Schema Design

Problem Statement

Decide the database and design the schema for product resources.

Acceptance Criteria

• Database choice finalised
• Schema design ready
• All guidelines are followed.

child of: #2