Nearfarm is a web application designed to revolutionize the local food ecosystem. It bridges the gap between consumers seeking fresh, locally sourced produce and local farmers struggling to reach a wider audience. By providing a user-friendly online marketplace, Nearfarm empowers small-scale farmers and individuals with surplus produce to sell directly to consumers, fostering a more sustainable and equitable food system.
- User-Friendly Interface: Nearfarm boasts an intuitive interface for easy navigation and product listing, ensuring a seamless user experience.
- Direct Transactions: Nearfarm enables direct transactions between farmers and consumers, fostering transparency and trust.
- Empowerment of Farmers: Small-scale farmers can reach a wider audience and sell their products professionally, breaking free from reliance on intermediary companies.
- Surplus Produce Sales: Individuals with surplus produce from personal gardens can conveniently list and sell their goods on the platform.
- Fully Mobile Responsive: Nearfarm is designed to be fully responsive on mobile devices, ensuring an optimal experience for users across all screen sizes.
- Integration with Third-Party Authentication Services: Nearfarm integrates with third-party authentication services such as Google and GitHub, providing users with seamless login options.
- Continuous Integration and Deployment: New code is merged into the integration branch and subsequently deployed to the main branch for releases. Vercel bot automates specific tasks, ensuring smooth operations.
- Testing: Frontend unit tests are conducted using Jest, while backend automation testing is performed with Postman.
- Frontend: NextJs (app router)
- Backend: NodeJs
- Hosting: Vercel
- Database: MongoDB
- Authentication: NextAuth.js
- Frontend Unit Testing: Jest
- Backend Automation Testing: Postman
- API Requests: Axios
- UI Component Library: shadcn/ui and Tailwind CSS
- Form Handling: React Hook Form
- Other Dependencies: Refer to
package.jsonfor a complete list (additional dependencies like email sending libraries, date pickers, etc.)
- Integration Branch: All new code is initially merged into the
integrationbranch for rigorous testing. - Main Branch: Code is merged into the
mainbranch upon successful release. - Vercel Bot: Automates specific tasks to streamline deployment and maintenance processes.
Nearfarm utilizes both frontend unit tests and backend automation testing to ensure reliability and functionality.
Integration Branch: 
Main Branch:
Frontend unit tests are implemented using Jest. To run the frontend unit tests, use the following command:
npm test-
Clone the repository:
git clone https://github.com/vaibhavthapliyalx/NearFarm.git cd nearfarm -
Install dependencies for both frontend and backend:
npm install
-
Configure environment variables and start the development server:
npm run dev
Visit http://localhost:3000 to explore the application.
Nearfarm utilizes Vercel for seamless deployment and hosting. The deployment process is automated through Vercel's integration with GitHub.
Production Build: Visit now!
Vercel's bot triggers the deployment process upon detecting new code changes pushed to the GitHub repository. The changes are then automatically built and deployed to the production environment on Vercel.
This project is currently a work in progress. Developed as a Final Year Project at Ulster University, it is actively being developed to become the leading platform for connecting local farmers and consumers. I am continuously working on enhancing its features and functionality to provide a seamless experience for users.
Nearfarm is a Final Year project developed by Vaibhav Thapliyal. All rights to the codebase, including but not limited to its design, implementation, and associated documentation, are reserved. Any unauthorized use, reproduction, or distribution of the codebase or its components is strictly prohibited. The project maintainers and contributors disclaim any liability for any issues, damages, or legal consequences arising from the unauthorized use or distribution of Nearfarm. Any third-party services, libraries, or tools used in this project are the respective properties of their owners and may be protected by trademarks, copyrights, or other intellectual property rights. They are subject to their own terms and licenses.
We welcome any suggestions or feedback to improve Nearfarm. Feel free to open an issue if you encounter any bugs, have ideas for new features, or would like to suggest improvements to the existing functionality. Your input is valuable in shaping the future development of Nearfarm.
To open an issue, please follow these steps:
- Navigate to the Issues tab of the repository.
- Click on the "New Issue" button.
- Provide a descriptive title and detailed description of the issue or suggestion.
- Assign appropriate labels and milestones if applicable.
- Submit the issue.
This project is proprietary and currently not licensed for public use. All rights to the codebase are reserved by the project owner. Unauthorized use, reproduction, or distribution of the code is strictly prohibited. If you wish to use or modify the codebase, please contact the project owner for permission.