-
Notifications
You must be signed in to change notification settings - Fork 5
0.2.0 Product Requirements #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ArpitaDhir
wants to merge
6
commits into
tusharchou:main
Choose a base branch
from
ArpitaDhir:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
817ebbf
Base Class File
ArpitaDhir ac382db
Merge branch 'tusharchou:main' into main
ArpitaDhir 35a3990
Merge branch 'tusharchou:main' into main
ArpitaDhir f3d0d1f
Update partner.py
ArpitaDhir 3b647a2
Merge branch 'tusharchou:main' into main
ArpitaDhir 895d280
Create MVP-RequirementDoc.md
ArpitaDhir File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
|
||
# MVP Product Requirement Doc | ||
**No** |**Key Updates** | **Date Updated** | **Updated by** | ||
-- | -- | -- | -- | | ||
1 | First Draft Completed | 28 Nov 2024 | Arpita Dhir | | ||
2 | Team Review | 28 Nov 2024 | Tushar and Mrtunjay | | ||
|
||
## Objective | ||
|
||
This outlines the requirements for Local Data Platform, a web-based solution aimed at helping businesses make data-driven decisions. | ||
|
||
The platform will allow users to: | ||
|
||
1. Search for User insights | ||
2. Predict User Behaviour wrt Business | ||
3. Upload Business data for analysis | ||
4. Download User Insights as CSV files | ||
|
||
### **Problem Statement** | ||
|
||
Businesses often struggle to make informed decisions due to a lack of actionable insights. Access to predictive analytics tailored to their specific datasets remains limited, expensive, or overly complex. | ||
|
||
### **Who are we solving for?** | ||
|
||
- **Small to Medium-Sized Enterprises (SMEs)**: Businesses with limited access to dedicated data science teams or tools. | ||
- **Decision-Makers**: Business owners, managers, or analysts seeking clear, actionable insights from their data. | ||
|
||
### **Reasons it may not work?** | ||
1. Users might hesitate to upload sensitive business data | ||
2. Insights might be too complex or irrelevant for the target audience | ||
3. Issues with data ingestion, prediction accuracy, or CSV export functionality | ||
4. Low adoption due to insufficient marketing | ||
|
||
|
||
## **Phases** | ||
|
||
### MVP Mission | ||
1. Allow users to Log in/Sign up | ||
2. Users should have business insights dashboard | ||
3. They can search insights | ||
4. They can manage insights i.e add and delete | ||
6. Allows users to upload data to LDP | ||
7. Enables downloading of actionable insights in CSV format. | ||
|
||
## **Success Metrics** | ||
|
||
**Adoption Metrics** | ||
- Number of registered businesses [Aim: 10] | ||
- Percentage of users actively uploading data [Aim: 75%] | ||
- Cost to conversion [Aim: 2$] | ||
|
||
**Engagement Metrics** | ||
- Time spent on the platform [Aim: 2 hr] | ||
- Number of insights searched per user per hour [Aim: 5+] | ||
- Number of insights downloaded per user per hour [Aim: 5+] | ||
|
||
**Customer Satisfaction** | ||
- User retention rates [Aim: 50%] | ||
- User Churn rates [Aim: 20%] | ||
- NPS Feedback [70] | ||
|
||
|
||
Phase | Task | Timeline | Owner | Deliverables | ||
-- | -- | -- | -- | -- | ||
Planning | Finalize PRD | 24 Nov 24 | Tushar | Approved Doc | ||
Design | Create the handoff ready website design | 20 Dec 24 | Arpita | High-fidelity designs | ||
Frontend Dev | Build website on Framer | 24 Dec 24 | Arpita | Local Website | ||
Backend Dev | API and package integration | 24 Dec 24 | Tushar | APIs and backend services | ||
Integration | Combine frontend and backend | 28 Dec 24 | Tushar | Fully functional Staging Website | ||
Testing | QA and bug fixing | 28 Dec 24 | Tushar | Bug-free release-ready product | ||
Marketing | Social posts to engage till Launch | 15 Dec 24 - 15 Jan 25 | Arpita | Social Posts | ||
Deployment | Launch MVP | 15 Jan 25 | Tushar | Live platform | ||
|
||
## Specifications | ||
### **Product Design** | ||
- **Key Actions** | ||
- Authentication & Onboarding | ||
- Upload local data/ Ingest data | ||
- Search for insights | ||
- Download button for CSV exports. | ||
- Landing page with USP | ||
- Dashboard page | ||
- showcasing insights | ||
- data upload/download options | ||
- pinned data insights | ||
- **Frontend**: Framer | ||
- Responsive Design | ||
|
||
### **Backend Requirements** | ||
- **Framework**: Python | ||
- **Key Actions**: | ||
- Data ingestion APIs for parsing and validating uploaded files. | ||
- Prediction model powered by LDP | ||
- RESTful APIs for frontend-backend communication. | ||
- Export functionality to create CSV files for download. | ||
- **Database**: | ||
|
||
### **Testing** | ||
- **Unit Testing**: Validate frontend components and backend APIs. | ||
- **Integration Testing**: Ensure seamless interaction between frontend and backend. | ||
- **User Acceptance Testing (UAT)**: Validate product functionality with beta users. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
""" | ||
Product Requirements Doc | ||
|
||
Product? | ||
- Users are people who want to find and learn new recipes | ||
- Recipe is an explanation of how a dish is made. It has: | ||
- ingredients: quantity, ingredient name | ||
- process | ||
- prep time: minutes | ||
- cook time: minutes | ||
- difficulty: easy, intermediate, hard | ||
- course: starter, main course, dessert, beverage | ||
- Price: Rupees | ||
- Offline Dinners | ||
- Register: Must be signed in to attend event | ||
- Dinner Name | ||
- Cuisine | ||
- Chef Name | ||
- Menu: All dishes available for dinner | ||
- Price: Rupees | ||
""" | ||
from local_data_platform import helloworld | ||
from local_data_platform.entity import User, Product | ||
from local_data_platform.transaction import Transaction | ||
|
||
|
||
|
||
''' | ||
Product? Uber | ||
User? Rider & Driver | ||
Handshake? | ||
_Booking_ | ||
*Event_id* | ||
Rider :+1 Uber | ||
Uber :? Driver | ||
Driver :+1 Uber | ||
Uber :+1 Rider | ||
''' | ||
class Booking(Transaction): | ||
|
||
def __init__(self, product: Uber, provider: Driver, consumer: Rider): | ||
self.product = product | ||
self.provider = provider | ||
self.consumer = consumer | ||
|
||
def get(): | ||
pass | ||
|
||
def put(): | ||
pass | ||
class Uber(Product): | ||
|
||
|
||
class Rider(User): | ||
|
||
|
||
class Driver(User): | ||
|
||
|
||
helloworld() |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.