-
Notifications
You must be signed in to change notification settings - Fork 590
Update README.md #4
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
Open
Mufeeda-K
wants to merge
1
commit into
tinkerhub:main
Choose a base branch
from
Mufeeda-K:patch-1
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.
Open
Changes from all commits
Commits
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 |
|---|---|---|
| @@ -1,99 +1,66 @@ | ||
| # [Project Name] 🎯 | ||
|
|
||
|
|
||
| ## Basic Details | ||
| ### Team Name: [Name] | ||
|
|
||
|
|
||
| ### Team Members | ||
| - Member 1: [Name] - [College] | ||
| - Member 2: [Name] - [College] | ||
| - Member 3: [Name] - [College] | ||
|
|
||
| ### Hosted Project Link | ||
| [mention your project hosted project link here] | ||
|
|
||
| ### Project Description | ||
| [2-3 lines about what your project does] | ||
|
|
||
| ### The Problem statement | ||
| [What ridiculous problem are you solving?] | ||
|
|
||
| ### The Solution | ||
| [How are you solving it? Keep it fun!] | ||
|
|
||
| ## Technical Details | ||
| ### Technologies/Components Used | ||
| Farmer's Unit 🎯 | ||
| Basic Details | ||
| Team Name: NA | ||
| Team Members | ||
| Member 1: Mufeeda.K - MES College of Engineering, Kuttipuram | ||
| Member 2: NA | ||
| Member 3: NA | ||
| Hosted Project Link | ||
| Farmer's Unit Demo | ||
|
|
||
| Project Description | ||
| The Farmer’s Unit project facilitates the sale of local farm products and provides detailed information about crops produced locally. It helps increase farmers' profits by eliminating middlemen. Customers can directly access product details such as price, quantity, and availability, and farmers can sell their crops in a timely manner before the shelf life expires. | ||
|
|
||
| The Problem Statement | ||
| Customers have direct access to local farmers, ensuring better quality products. | ||
| Farmers can sell crops before they spoil, avoiding wastage and maximizing profits. | ||
| The Solution | ||
| The solution is a user-friendly website that connects local farmers directly with customers. It provides a platform where customers can get updated information about available products, prices, and quantities, and farmers can easily list and manage their products. | ||
|
|
||
| Technical Details | ||
| Technologies/Components Used | ||
| For Software: | ||
| - [Languages used] | ||
| - [Frameworks used] | ||
| - [Libraries used] | ||
| - [Tools used] | ||
|
|
||
| JavaScript | ||
| Vite + React | ||
| React-markdown | ||
| IDX (Identity Exchange) | ||
| Vercel (for deployment) | ||
| For Hardware: | ||
| - [List main components] | ||
| - [List specifications] | ||
| - [List tools required] | ||
|
|
||
| ### Implementation | ||
| NA | ||
| Implementation | ||
| For Software: | ||
| # Installation | ||
| [commands] | ||
|
|
||
| # Run | ||
| [commands] | ||
|
|
||
| ### Project Documentation | ||
| Installation: | ||
| Clone the repository to your local system: | ||
| ```bash | ||
| git clone https://github.com/tinkerhub/farmer-six.git | ||
| ``` | ||
| Install dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
| Run the application: | ||
| ```bash | ||
| npm start | ||
| ``` | ||
| Project Documentation | ||
| For Software: | ||
|
|
||
| # Screenshots (Add at least 3) | ||
|  | ||
| *Add caption explaining what this shows* | ||
|
|
||
|  | ||
| *Add caption explaining what this shows* | ||
| Screenshots: | ||
| Farmer's Login Page: | ||
|
|
||
|  | ||
| *Add caption explaining what this shows* | ||
| Product Entering Page: | ||
|
|
||
| # Diagrams | ||
|  | ||
| *Add caption explaining your workflow* | ||
| Product Details Page: | ||
|
|
||
| For Hardware: | ||
|
|
||
| # Schematic & Circuit | ||
|  | ||
| *Add caption explaining connections* | ||
|
|
||
|  | ||
| *Add caption explaining the schematic* | ||
|
|
||
| # Build Photos | ||
|  | ||
|
|
||
|
|
||
|  | ||
| *List out all components shown* | ||
| Product Description: | ||
|
|
||
|  | ||
| *Explain the build steps* | ||
|
|
||
|  | ||
| *Explain the final build* | ||
|
|
||
| ### Project Demo | ||
| # Video | ||
| [Add your demo video link here] | ||
| *Explain what the video demonstrates* | ||
|
|
||
| # Additional Demos | ||
| [Add any extra demo materials/links] | ||
|
|
||
| ## Team Contributions | ||
| - [Name 1]: [Specific contributions] | ||
| - [Name 2]: [Specific contributions] | ||
| - [Name 3]: [Specific contributions] | ||
|
|
||
| --- | ||
| Team Contributions | ||
| Mufeeda.K: Frontend development (React), Product page creation, Design & UI development. | ||
| Member 2: NA | ||
| Member 3: NA | ||
| Made with ❤️ at TinkerHub | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the start command for Vite.
Since this is a Vite project, the start command should be
npm run devinstead ofnpm start. Also, consider adding the development server URL and port information that will be displayed after starting the application.+The development server will start at http://localhost:5173