Skip to content
GitLab

Main_Description · Changes

Page history
Update Body authored by Akshit Marwaha's avatar Akshit Marwaha
Hide whitespace changes
Inline Side-by-side
Main_Description.md
View page @ ba0e3dd8
---
title: Body
---
# Final Deliverable III: Pure Roots
# Final Deliverable III
## Required Links
- [GitLab Repository](https://gitlab.com/AkshitMarwaha1000/purroots_project)
- [YouTube Demo](https://www.youtube.com/shorts/jFlHVF2ktgo)
- **GitLab**: [GitLab Link](https://gitlab.com/AkshitMarwaha1000/purroots_project)
- **YouTube**: [YouTube Link](https://www.youtube.com/shorts/jFlHVF2ktgo)
---
## Project Description
## Describe Your Project
### Problem Statement
Our project addresses a significant disconnect between local farmers and consumers, which often leads to limited access to fresh, locally sourced produce and reduced income opportunities for farmers. Many consumers face challenges finding high-quality, local food, while farmers struggle to reach target markets and effectively showcase their products.
......@@ -18,29 +18,17 @@ Our project addresses a significant disconnect between local farmers and consume
To bridge this gap, we are developing a web application that connects local farmers directly with consumers. This platform will streamline the food supply chain, allowing users to easily browse and purchase fresh produce, dairy, and meat products from nearby farms. By supporting local agriculture, we aim to provide healthier food options for consumers while enhancing farmers' access to local markets.
### What Makes Us Unique
1. **Direct from Local Farmers**
We connect you directly with local farmers, ensuring the freshest, seasonal produce and fair compensation for the growers. Every purchase supports your local agricultural community.
At **Pure Roots**, we’re transforming the way you experience fresh, local food. Here’s why we stand out:
1. **Direct from Local Farmers**: We connect you directly with local farmers, ensuring the freshest, seasonal produce and fair compensation for the growers. Every purchase supports your local agricultural community.
2. **Freshness You Can Trust**: Our products are sourced straight from the fields, reaching you with minimal handling and transport. It’s farm-to-table, as fresh as it gets.
3. **Community-Centered Values**: We’re more than a platform—we’re a movement to build stronger, more sustainable communities. By supporting local farmers, you help nurture the backbone of our food system.
4. **Sustainable Choices**: By sourcing locally, we reduce food miles and minimize our environmental footprint. Choosing Pure Roots is a step toward a greener, more sustainable future.
5. **Customizable for Your Needs**: Whether you’re shopping for fresh fruits, vegetables, dairy, or other local products, Pure Roots offers the flexibility to choose exactly what you need—no pre-packed constraints, just fresh, wholesome choices.
2. **Freshness You Can Trust**
Our products are sourced straight from the fields, reaching you with minimal handling and transport. It’s farm-to-table, as fresh as it gets.
### Featured Products
A carousel or grid showcasing popular items (e.g., “Fresh Tomatoes,” “Farm-Fresh Eggs”).
3. **Community-Centered Values**
We’re more than a platform—we’re a movement to build stronger, more sustainable communities. By supporting local farmers, you help nurture the backbone of our food system.
4. **Sustainable Choices**
By sourcing locally, we reduce food miles and minimize our environmental footprint. Choosing Pure Roots is a step toward a greener, more sustainable future.
5. **Customizable for Your Needs**
Whether you’re shopping for fresh fruits, vegetables, dairy, or other local products, Pure Roots offers the flexibility to choose exactly what you need—no pre-packed constraints, just fresh, wholesome choices.
---
## Featured Products
A carousel or grid showcasing popular items (e.g., "Fresh Tomatoes," "Farm-Fresh Eggs").
---
## How It Works
### How It Works
1. **Browse Products**: Explore fresh, locally sourced items on our app or website.
2. **Choose & Order**: Pick what you need and place your order directly with local farmers.
3. **Farm-Fresh Delivery**: Enjoy fresh, sustainable produce delivered right to your doorstep.
......@@ -48,7 +36,12 @@ A carousel or grid showcasing popular items (e.g., "Fresh Tomatoes," "Farm-Fresh
---
## About Us
Welcome to Pure Roots, your direct link to fresh, locally grown produce. We’re on a mission to empower farmers and bring the freshest, healthiest food to your doorstep. Our platform eliminates middlemen, ensuring fair prices for farmers and affordability for consumers.
Welcome to **Pure Roots**, your direct link to fresh, locally grown produce. We’re on a mission to empower farmers and bring the freshest, healthiest food to your doorstep. Our platform eliminates middlemen, ensuring fair prices for farmers and affordability for consumers.
At **Pure Roots**, we believe in:
- **Supporting Local Communities**: Helping local farmers thrive.
- **Sustainability**: Reducing food miles and environmental impact.
- **Transparency**: Knowing where your food comes from.
### Our Values
- **Freshness**: Straight from farms to your table.
......@@ -58,114 +51,149 @@ Welcome to Pure Roots, your direct link to fresh, locally grown produce. We’re
---
## Architectural Model Diagram
![image](uploads/92e387bc3022c9c9e852d99854c0ec77/image.png)
### Frontend (User Interface):
### Frontend (User Interface)
- **Devices Supported**: Desktop, tablet, and smartphones.
- **Technologies Used**:
- HTML, CSS, JavaScript for structure and interactivity.
- Bootstrap for responsive design.
- Swiper.js for sliders.
- **Features**:
- User registration and login interface.
- Product catalog with search, filter, and cart management.
- Farmer profiles with ratings and reviews.
### Backend (Application Logic):
- **Technologies Used**: Node.js with Express.js.
- Bootstrap for responsive design ensuring usability across devices.
- Swiper.js for creating engaging sliders for product showcasing.
#### Features:
- User registration and login interface.
- Product catalog with search, filter, and cart management options.
- Farmer profiles with ratings and reviews.
- Educational content on local farming and recipes.
### Backend (Application Logic)
- **Technologies Used**: Node.js with Express.js for a robust and scalable backend.
- **Programming Language**: JavaScript.
- **Features**:
- User authentication and session management.
- API endpoints for handling frontend requests.
- Logic for cart operations, order tracking, and farmer data management.
### Database (Data Storage):
#### Features:
- User authentication and session management.
- API endpoints for handling frontend requests.
- Logic for cart operations, order tracking, and farmer data management.
### Database (Data Storage)
- **Database Type**: SQL using MySQL versions.
- **Features**:
- Secure storage for user profiles, product details, and order history.
- Support for querying seasonal product availability and farmer information.
#### Features:
- Secure storage for user profiles, product details, and order history.
- Support for querying seasonal product availability and farmer information.
### External Services:
- **Payment Gateway**: Not functional yet but provisioned for future integration.
- **Map Integration**: Planned for locating nearby farmers or tracking deliveries.
- **Payment Gateway**: Currently not functional but provision exists for future integration.
- **Map Integration**: Can be added later for locating nearby farmers or tracking deliveries.
- **Notification Services**: To be implemented for order confirmations or promotional updates.
### Cloud Hosting:
- **Hosting Provider**: GitLab.
- **Deployment**: CI/CD pipeline for updates and scaling.
- **Deployment**: Continuous Integration/Continuous Deployment (CI/CD) pipeline for smooth updates and scaling.
### Communication Protocols:
- Frontend to Backend: HTTPS for secure communication.
- Backend to Database: Secure queries with SSL/TLS encryption.
- Backend to External Services (Future Scope): APIs with OAuth or token-based authentication.
---
## Status Report
## Support for Functional and Quality Attributes
### Functional Attributes
- **User Registration and Profiles**: Enables users to create accounts, save preferences, and manage order history securely.
- **Product Catalog and Search**: Allows efficient browsing and filtering of locally available products.
- **Order Management**: Handles shopping cart functionalities and maintains a record of orders.
- **Farmer Profiles and Reviews**: Highlights farmer practices and incorporates a review system for transparency.
### Quality Attributes
- **Usability**: Designed with Bootstrap for intuitive navigation on all devices. Easy-to-use sliders with Swiper.js enhance user engagement.
- **Performance**: Node.js ensures non-blocking, fast request processing. Optimized MySQL queries for quick data retrieval.
- **Scalability**: GitLab hosting with CI/CD enables seamless scaling for future traffic.
- **Security**: HTTPS and TLS encryption safeguard sensitive user data.
### Communication Protocols:
- Backend to Database: MySQL queries executed over a secure connection.
- Backend to Future External Services: APIs secured with tokens or OAuth for authentication.
---
## Status Report and Demo Summary for Pure Roots
### Functionalities Implemented
- **User Registration and Profiles**: Users can create accounts and manage basic profiles.
- **Product Catalog and Search**: Comprehensive catalog, sortable by categories, location, and price.
- **User Registration and Profiles**: Users can successfully create accounts and manage basic profiles.
- **Product Catalog and Search**: A comprehensive catalog is available, sortable by categories, location, and price.
### Functionalities Partially Implemented
- **Order Management**: Cart functionality available; backend integration pending.
- **Order Management**: Users can add items to the cart. However, order review and status tracking functionalities are only available on the frontend, with backend integration yet to be enabled.
### Functionalities Not Fully Implemented
- **Farmer Profiles and Reviews**: Only admin profiles available; time constraints prevented full implementation.
- **Payment Processing**: Feature development began late and remains incomplete.
- **Educational Resources**: Deemed unnecessary for the current scope.
### Functionalities Not Fully Implemented and Reasons
- **Farmer Profiles and Reviews**: Only one admin profile is currently enabled. Multiple farmer profiles were not implemented due to time constraints.
- **Payment Processing**: No payment methods have been activated. This feature was dropped because work on the payment gateway began only a week ago after the review meeting, leaving insufficient time for complete implementation.
- **Educational Resources**: Recipes and nutritional information were removed as they were deemed unnecessary for the current scope.
- **Seasonal Offerings**: Highlighting seasonal products was not implemented, as this feature was deprioritized due to its limited perceived value at this stage.
- **Real-Time Order Tracking**: This feature was not implemented due to time limitations and prioritization of other core functionalities.
---
## Use Case Model
### Use Case 1: User Registration
- **Actors**: Consumer
- **Main Flow**:
1. User navigates to the sign-in/sign-up page.
2. User fills out the registration form (name, email, password).
3. User submits the form.
4. System confirms registration and redirects to the profile.
### Use Case 2: Product Search and Order Placement
- **Actors**: Consumer
- **Main Flow**:
1. User navigates to the product catalog.
2. User searches for specific products or browses categories.
3. User adds desired items to the cart.
4. User reviews the cart and proceeds to checkout.
## Revised UML Diagram
---
### Projected Members Contribution
- **Saumyaa Gelani**
- **Role**: Oversees project management and frontend development.
- **Responsibilities**: Manage project progress, design wireframes, implement frontend, conduct usability testing, develop marketing materials, etc.
- **Commit Frequency**: At least two commits per week.
- **Akshit Marwaha**
- **Role**: Focuses on developing and maintaining the backend.
- **Responsibilities**: Develop server-side logic, manage database, implement security measures, collaborate on frontend-backend integration.
- **Commit Frequency**: At least three commits per week.
## Functional Properties (FPs)
1. **User Registration and Profiles**: Personalize the shopping experience by saving preferences and order history.
2. **Product Catalog and Search**: Comprehensive catalog for efficient browsing.
3. **Order Management**: Cart functionalities for seamless purchasing.
4. **Payment Processing**: Secure transaction handling (future implementation).
5. **Farmer Profiles and Reviews**: Transparency through farmer profiles and consumer reviews.
- **Krish Sharma**
- **Role**: Ensures quality and reliability through testing.
- **Responsibilities**: Develop and execute test plans, conduct usability testing, monitor system performance, document test results, etc.
- **Gokulhesh Khanna**
- **Role**: Focuses on documentation and API integration testing.
- **Responsibilities**: Organize project documentation, assist with API integration, collaborate on user guides, test newly integrated features, etc.
---
## Quality Attributes (QAs)
### Usability
- Intuitive interface with responsive design for all devices.
- Accessible navigation and clear labeling.
## Task Breakdown
### Performance
- Optimized backend and frontend for minimal latency.
- Use of caching and CDN for faster loading.
### Tasks Accomplished:
- **Major Contributor**: Saumyaa, Akshit, Krish, Gokulhesh
- **Minor Contributors**: Akshit, Krish
### Security
- HTTPS and TLS encryption for secure data handling.
- Regular security audits to prevent breaches.
### Website Setup & Finalized Edits:
- **Major Contributor**: Akshit
- **Minor Contributor**: NA
---
## Team Contributions
| **Member** | **Role** | **Responsibilities** |
|-------------------|-------------------------|-------------------------------------------------------------------------------------|
| **Saumyaa Gelani** | Frontend Development | UI/UX design, frontend coding, usability testing, user guides. |
| **Akshit Marwaha** | Backend Development | Node.js development, API creation, database management, system performance. |
| **Krish Sharma** | Testing and QA | Test cases, usability testing, system performance, bug reporting. |
| **Gokulhesh Khanna**| Documentation and QA | Documentation, GitLab Wiki management, API endpoint testing, security validation. |
## Proposed Project
---
### Unique Features and Benefits:
- **Farmer Profiles**: Detailed profiles highlighting farming practices.
- **Seasonal Offerings**: A catalog of seasonal products.
- **Educational Components**: Recipes, nutritional information, and educational resources for promoting healthier eating habits.
## Societal Impact
1. **Support for Local Economies**: Contributing to the resilience of rural communities.
2. **Sustainability**: Reducing environmental impact through local sourcing.
3. **Community Building**: Strengthening social ties and raising awareness of sustainable practices.
### Platform Choice:
- Web-based platform accessible from any device with internet connectivity.
---
### Societal Impact:
- **Supporting Local Economies**: Creates a direct market for local farmers.
- **Promoting Sustainable Agriculture**: Encourages local sourcing, reducing environmental impact.
- **Building Community Connections**: Fosters a sense of community and supports sustainable practices.
### Requirements Statement:
The project addresses the disconnect between local farmers and consumers by creating a web application that facilitates a more efficient and sustainable food supply chain. The platform will include features like user registration, product catalogs, order management, payment processing, and farmer profiles with reviews.
---
## UML DIAGRAM
### Use Case Model:
1. **User Registration**
- **Actors**: Consumer
- **Preconditions**: User has internet access.