Farm Sanctuary

This is the official Farm Sanctuary web app documentation

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing

📃 About The Project

FarmSanctaury is a sustainable farming web application that aims to provide farmers with a platform to adopt sustainable farming practices and increase the overall sustainability of agriculture. The application will offer features such as:

• 👦Advanced authentication: using facial recognition to match the identity of the user both farmers and client

• 🎍Crop selection and planning: AI model to help make decisions for you on what crop to grow and which seed to plant based on soil type, weather conditions and available resources.

• 💬Building a community: blog and forum ,exchange messages , badge system , best rated article , most active user , stars to each article.

• 📦Farmers' market: offer farmers increased profit over selling to wholesalers, food processors, or large grocery firms. By selling directly to consumers, produce often needs less transport, less handling, less refrigeration and less time in storage.

• 📅Calendar View: A visual calendar interface that displays all tasks and activities, allowing farmers to easily see what needs to be done and when , including task Management ; A system for creating, managing, and tracking tasks, including assigning tasks to specific team members and setting due dates.

• 🎈Notifications: A system for sending reminders and notifications to farmers, reminding them of upcoming tasks or important deadlines.

• 💡Tips and tricks: Information on sustainable farming techniques and resources for implementing them.

• 📈Data analysis and reporting: Information and resources to measure the impact of sustainable farming practices on the environment, economy, and community.

• 📱 Mobile app : Mobile app built for farm sanctuary delivery agent to ensure transparency between client and his package

The goal of the web application is to promote sustainable agriculture, reduce waste and environmental impact, and provide farmers with the tools and resources they need to succeed in their farming operations.

(back to top)

🚀 Built With

You may find below the list of the frameworks/libraries that we used to build our project :

(back to top)

✨ Getting Started

To get a local copy up and running follow these simple example steps.

🚧 Prerequisites

You may find below the list of things you need to use this project :

• Make sure nodejs is running on your system.
• You will need to install the "yarn" or "npm" command line.

🛠 Installation

In order to install the app you need to follow the instructions below :

1. Clone the repo

   git clone https://github.com/rayen-creator/farm_sanctuary.git

2. Install NPM packages dependencies
   

   $ cd frontend/

   $ npm install 

   Or

   $ yarn install 

   then

   $ cd backend/

   $ npm install 

   Or

   $ yarn install 

3. Run server on
   

   📍 Angular Server

   ng serve --open

   📍 ExpressJS Server

   nodemon server.js

(back to top)

😎 Contributing

If you have a suggestion that would make this project better, please fork the repo and create a pull request. Any contributions you make are greatly appreciated. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b Yourbranch)
3. Commit your Changes (git commit -m 'Add some features to project')
4. Push to the Branch (git push origin Yourbranch)
5. Open a Pull Request

(back to top)

Developed with ❤️ by JediScripts.