Skip to content

Latest commit

 

History

History
159 lines (109 loc) · 4.46 KB

README.md

File metadata and controls

159 lines (109 loc) · 4.46 KB
Raw

Treetracker Web

Current Milestones and Issue Topics.

Developers please see current milestones here:
https://github.com/Greenstand/treetracker-web-map/milestones

Big picture UX/UI challenges are tracked at:
https://github.com/Greenstand/treetracker-web-map/issues?q=is%3Aissue+is%3Aopen+label%3AUX%2FUI

   

Project Description

Displays location and details of all trees that have been tracked.

Live map is at www.treetracker.org

For more details see the [Tree Tracker Web Map Wiki] (https://github.com/Greenstand/treetracker-web-map/wiki)

   

Development Environment Quick Start

Local development

  1. Install postgres
  2. Install postGIS
  3. Create a database named 'treetracker'
  4. Import our developer seed into your database. Seed can be downloaded at https://developer-resources.sfo2.cdn.digitaloceanspaces.com/treetracker_developer_seed.sql.gz
  5. Configure server/src/config/config.js to point to your local database
  6. Install node modules, run npm i in server/ folder
npm i
  1. Install supervisor globally
npm i -g supervisor
  1. Run server.js with CORS restrictions lifted
NODE_ENV=dev supervisor server.js
  1. Open client/js/config.js from the project root. It should contain only the following 2 lines
var configTreetrackerApi = 'http://localhost:8080/api/web/;
  1. Open the index.html file of the webmap in a web browser. Use file:/// protocol, not a localhost address.

Using online DB

  1. Skip installation of postgres/postgis
  2. Make sure all npm modules are installed under client and server.
cd client
npm i

cd server
npm i
  1. Start the server
cd server
npm run dev
  1. Start the client
cd client
npm start
  1. Open the web map in the browser with URL: http://localhost:3000

NOTE: in this way, the server would run on port 3001, and client would run on port 3000.

Alternative development environment for MS Windows (Works on Linux and Mac also)

On Windows, the easiest way to develop and debug Node.js applications is using Visual Studio Code. It comes with Node.js support out of the box.

https://code.visualstudio.com/docs

   

Web App installation issues

Error: Failed to load resource: the server responded with a status of 404 (Not Found)

map.js:18 Uncaught ReferenceError: configTreetrackerApi is not defined at map.js:18

Solution: To Solve this issue, go into the client/js folder, and either change the file config.js.example to config.js, or copy it into a file of the same name.

   

Clustering Basics

For performance and UX purposes, since this map needs to deal with an enormous amount of trees, a clustering strategy is used to group those trees, showing information in a way that is more digestible for the end-user.

Although this feature is already implemented, performance optimizations are a work in progress.

Overriding clustering and map initial zoom for testing

When there is a need to tweak the clusterization behavior, the cluster radius and zoom can be overridden specifying query strings. For example, if you need to load the map with an initial zoom level of 15, and a radius of 0.001 you will access it like this:

dev.treetracker.org?zoom=15&clusterRadius=0.001

To find the correct value for the cluster radius in a given zoom level, play with some ranges between 0.1 and 0.00025. However, feel free to experiment however you like.

When these values are overridden, you can zoom and drag the map freely, while keeping the same clusterization behaviors.

Another useful tool to use in conjunction with this is the web browser's console (in Chrome or Firefox, hit F12 to open it). Whenever the map is updated, current zoom level and cluster radius used will be output to the console, so you have a better idea of what is going on.

Future:

  • Filters and Statistics
  • View photo together with tree data
  • View planter profile.

How to enable log on console.

By default, the client just output logs which are level of warn or above, this remains the browser console clean for normal users, to display more logs for debuggering, please follow this guide:

  1. Open the browser console panel.

  2. Open application tab, then open Local Storage tab:

  3. Add a key-value pair:

key: loglevel value: DEBUG

  1. Refresh the page.

demo for set log

How to test

We use Jest to build tests.

  1. To test client
cd client
npm test
  1. To test server
cd server
npm test