From ae8061311228310aa02e4e19f09f64c0f13fa3ea Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 18 Jul 2016 16:36:12 -0500 Subject: [PATCH 1/5] Update README.md --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fc41bd..c60ea3d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ # node-OpenDroneMap -Node.js API to access OpenDroneMap. https://github.com/OpenDroneMap/OpenDroneMap +Node.js GUI and REST API to access [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) + +![Alt text](/screenshots/main.png?raw=true "Node-OpenDroneMap") + +## Getting Started + +The quickest way is to use [Docker](https://www.docker.com/). + +* From the Docker Quickstart Terminal (Windows / OSX) or from the command line (Linux) type: +``` +git clone https://github.com/pierotofy/node-OpenDroneMap +cd node-OpenDroneMap +docker build -t nodeodm:latest . +docker run -p 3000:3000 nodeodm:latest +``` + +* If you're on Windows/OSX, find the IP of your Docker machine by running this command from your Docker Quickstart Terminal: + +``` +docker-machine ip +``` + +Linux users can connect to 127.0.0.1. + +* Open a Web Browser to `http://:3000` + +And you're done! + +### Run it Natively + +If you are already running [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) on Ubuntu natively, you can simply type: + +``` +sudo curl --silent --location https://deb.nodesource.com/setup_6.x | sudo bash - +sudo apt-get install -y nodejs +git clone https://github.com/pierotofy/node-OpenDroneMap +cd node-OpenDroneMap +node index.js +``` + +## Contributing + +Make a pull request for small contributions. For big contributions, please open a discussion first. + +## Roadmap + +- [ ] Command line options for OpenDroneMap (in progress) +- [ ] Cluster tasks distribution to multiple servers (planned) +- [ ] Documentation (planned) + +## API Docs + +Coming soon. From 352b05eb63c4d38b46bbf8d9df60ce11470b92b7 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 18 Jul 2016 16:40:01 -0500 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c60ea3d..ab95091 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # node-OpenDroneMap -Node.js GUI and REST API to access [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) +Node.js App and REST API to access [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) ![Alt text](/screenshots/main.png?raw=true "Node-OpenDroneMap") From 1f013914a635d8eb5d9aa9eba78c9ca2e4cc7a3f Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 18 Jul 2016 16:50:41 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ab95091..957432a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,10 @@ cd node-OpenDroneMap node index.js ``` +### Test Images + +You can find some test drone images from [OpenDroneMap's Test Data Folder](https://github.com/OpenDroneMap/OpenDroneMap/tree/master/tests/test_data/images). + ## Contributing Make a pull request for small contributions. For big contributions, please open a discussion first. From 72eb1649b6a4011992455ad1502eec3f2d705a36 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 18 Jul 2016 16:58:59 -0500 Subject: [PATCH 4/5] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 957432a..87b23fb 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,7 @@ Make a pull request for small contributions. For big contributions, please open - [ ] Command line options for OpenDroneMap (in progress) - [ ] Cluster tasks distribution to multiple servers (planned) - [ ] Documentation (planned) +- [ ] Unit Testing ## API Docs From f2ba409a31747c5c96d24023e3d69561a9eb7640 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 18 Jul 2016 16:59:14 -0500 Subject: [PATCH 5/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 87b23fb..91e5e21 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ Make a pull request for small contributions. For big contributions, please open ## Roadmap - [ ] Command line options for OpenDroneMap (in progress) -- [ ] Cluster tasks distribution to multiple servers (planned) -- [ ] Documentation (planned) +- [ ] Cluster tasks distribution to multiple servers +- [ ] Documentation - [ ] Unit Testing ## API Docs