Skip to content

BuildForSDG/farmers-edge-client

Repository files navigation

Netlify Status Codacy Badge

Farmers Edge

About

Farmers Edge enables small scale farmers double their productivity hence doubles their income. The app enables them to get ready market for their product, access useful info on farming and get funding for their farming activitty.

Why

This app aims to address hunger problem in the world by focusing on achievemment of Zero Hunger SDG.

Usage

Getting started

Prerequisites

- node
- browser(Preferably chrome)

Installation

git clone https://github.com/BuildForSDG/farmers-edge-client.git
cd farmers-edge-client
yarn install
yarn start

Further info

  • Install additional dependencies: yarn add <dependency-name> [-D]
  • Run tests: yarn test
  • Run tests with test coverage info: yarn test:cover
  • Check the codebase for proper syntax and formatting compliance: yarn lint
  • Run the app in local dev mode: yarn start. Sets up a local web server at localhost:3000

Url for the hosted app in Netlify

API is hosted in free Heroku account, the server enters sleep mode when not in use. If you notice a delay while sending a request, please allow a few seconds for the servers to restart.

  • https://fe-staging.netlify.app/

Functionality

Authentication

  • User can register
  • Verified user can login
  • User can reset password
  • Authenticated user can create a product
  • Authenticated user can create/place an order
  • User can send query using contact form

Authors

Contributing

If this project sounds interesting to you and you'd like to contribute, thank you! First, you can send a mail to buildforsdg@andela.com to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :

  1. area one (e.g this app is about human trafficking and you need feedback on your roadmap and feature list from the private sector / NGOs)

  2. area two (e.g you want people to opt-in and try using your staging app at staging.project-name.com and report any bugs via a form)

  3. area three (e.g here is the zoom link to our end-of sprint webinar, join and provide feedback as a stakeholder if you can)

Acknowledgements

LICENSE

MIT

About

The app helps to double the productivity and income of small scale food producers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors