🌾 FARMLOC

FARMLOC stands for Farmers-Agricultural-Resource-Management-and-Location-Of-Cold-storage.
It is a web-based platform designed to empower farmers by providing seamless access to agricultural resources, tools for management, and real-time information about the nearest available cold storages.

🔧 Tech Stack

Frontend:

Backend:

Database:

Authentication & Hosting:

✨ Features

• 📍 Cold Storage Locator – Find and connect with the nearest available cold storages in real-time
• 📊 Farm Resource Management – Track and manage seeds, fertilizers, and equipment easily
• 🔐 Secure Authentication – User login and registration powered by Firebase
• 📡 Real-Time Updates – Seamless communication between frontend and backend
• 🌐 Responsive UI – Mobile-first design with Tailwind CSS & Bootstrap
• 🤝 Collaboration Ready – Built for open-source contributions and hackathon scaling

📁 Project Structure (Basic Idea)

FARMLOC/
├── apps/
│   ├── frontend/
│   │   ├── src/
│   │   ├── public/
│   │   ├── package.json
│   │   └── ...
│   └── backend/
│       ├── routes/
│       ├── models/
│       ├── controllers/
│       ├── package.json
│       └── ...
├── README.md
└── ...

🛠️ Installation & Setup

1. Clone the repository:

    git clone https://github.com/your-username/FARMLOC.git
    cd FARMLOC
   

   Note: This repository has two branches:

   • main - Production/stable branch
   • dev - Development branch

2. Frontend Setup:

   cd apps
   cd frontend
   pnpm i
   pnpm dev
   

3. Backend Setup:

   cd apps
   cd backend
   pnpm i
   pnpm dev
   

🤝 Contributing

We ❤️ contributions! If you’d like to contribute to FARMLOC:

1. Fork the repository
2. Clone your fork locally
3. Create a new branch from dev
4. Make your changes and test thoroughly
5. Commit with a clear message
6. Push to your fork and open a Pull Request to dev

📌 All pull requests should target the dev branch.
Please ensure your code follows our standards and includes proper documentation.

⭐ Don’t forget to star our repo if you like this project! 🌱💚

📝 Development Workflow

# 1. Switch to dev branch
git checkout dev

# 2. Pull latest changes from dev
git pull origin dev

# 3. Create a new feature branch
git checkout -b feature/your-feature-name

# --- Make your changes in the codebase now ---

# 4. Stage and commit your changes
git add .
git commit -m "Add your commit message"

# 5. Push to your feature branch
git push origin feature/your-feature-name

# 6. Create a Pull Request
# (Use the GitHub/GitLab/Bitbucket web UI to open a PR from feature/your-feature-name to dev)

🚦 Getting Started

1. Ensure you have Node.js and pnpm installed
2. Follow the installation steps above
3. Start both frontend and backend servers
4. Navigate to the frontend URL (typically http://localhost:3000)
5. Begin exploring FARMLOC features!

🙌 Our Contributors

We thank all the amazing contributors who help make FARMLOC better every day! 🌾💚

---

🎉 This project is listed in GirlScript Summer of Code 2025!

🎉 This project is listed in Open Source Connect India 2025!

We welcome all contributors participating via GSSoC’25 & OSCI'25. Come, collaborate, and grow with us!

📧 Support

For any questions or issues, please create an issue in the repository or contact the development team.

📜 License

This project is licensed under the MIT License – you’re free to use, modify, and distribute it with attribution.

See the LICENSE file for details.

Maintainer

Pujan Sarkar

Your support helps us grow and reach more farmers. Happy Coding! 🌱