Skip to content

BuildForSDGCohort2/Team-299-Group-A-kyakulya

Repository files navigation

kyakula App - Your online farm store

Codacy Badge Netlify Status

About kyakulya

Kyakulya is an online food market platform that links farmers and food suppliers to consumers in Uganda. This platform tackles the following issues;

  • Helping farmers and suppliers locate local markets that offer high demand for their goods
  • Link farmers and suppliers directly to the final consumers wihout the need for a local market or middleman

Usage

Visit kyakulya.com for the experience

Setup

Install npm or yarn if you dont have any of them already installed. We recommend Yarn though.

After clonning the repo to your local machine and moving into the cloned folder, Run yarn install to get started by installing dependencies.

src/index.js is the entry to the project and source code should go into the src folder.

All tests should be written in the `tests' folder. There's a sample in there.

This starter uses Parcel as the bundler. It is much simpler that WebPack and the others

Hints

  • Run npm install or yarn install to get started. We'll assume you are using Yarn.
  • 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 your app in local dev mode: yarn start. This puts the bundled app in a dist folder, set up a local web server at localhost:1234, and continues to watch for your code changes which it syncs with the local server. This means if you loaded the app in a browser, it will auto-refresh as you code along. Feel free to use whatever bundler best meets your needs. Parcel was only added as a sample and for those looking for a simple but effective solution to the hassle of bundlers.

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. features to include on the platform
  2. Creating and working on issues
  3. Providing relevant sources of data to feed our database

Acknowledgements

-Andela Learning Community

LICENSE

MIT