The purpose of this repo is house the client side code for the FarmGeek web application. FarmGeek is a new web-based application for policy makers, researchers, funders, donors, and farm extension agents to identify the balance of the evidence for different on-farm interventions for agricultural outcomes such as yield, biodiversity, human health.
This repository has been developed by worklearn students at the University of British Columbia, under direction of Zia Mehrabi and Navin Ramankutty. It is currently maintained by Zia Mehrabi, at the University of Colorado Boulder. Any questions please contact ziamehrabi@gmail.com.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them. No need to install again if you already have installed these tools previously.
-
This project uses Git as our version control manager. Install the latest version in order to have version control for the project.
-
open your command line tool and navigate to the directory you wish to install the project into and download the project using
git clone <project-repo-link> -
download latest version of node as npm (node package manager) and node.js server language are used in the project.
-
This project uses the javascript framework Angular. Install Angular CLI by running this command on the command line at the root of your project directory.
npm install -g @angular/cli
A step by step series of examples that tell you how to get a development env running. Type all commands into the root of your project directory.
Install all project dependencies using npm.
npm install
To run project locally use the command
npm start
The app will run locally on the url http://localhost:4200/
End with an example of getting some data out of the system or using it for a little demo
As of April 2021, the test suite needs to be remade as they are not up to date (so ignore this section of README)
The Project contains Unit tests using Karma, and E2E tests using Protractor.
Run ng test
Run ng e2e
Run ng build to build the project locally. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
This project is hosted with Heroku. Deployment of this project to heroku is done from the mical_server project. Look at its Readme for instructions on deployment.
- Angular - The web framework used
- npm - Package manager for Node JavaScript platform
- flot - library used to create JavaScript charts
- RxJS - library for composing asynchronous and event-based programs
- Mapbox - Map library for JavaScript
- The Contact Form is linked to a Google Forms Application. Responses can be accessed via the agrimical gmail account.
- Jaehun Song
- Candice Pang
- Victor Pineda Gonzalez