imrajdeepb / dronesym

Dronesym is a platform enabling users to handle and track their drone fleets in real time. Users can have functionality to add new drones configure their flight paths and monitor their progress through a web dashboard.

DroneSym

Setting Up the Project

Prerequisites

1. Install Node.js 6.x (or higher)
2. Python version 2.7 (or higher)

Part 1 - Setting up the Node environment

1. After cloning the repo navigate to dronesym-node folder
2. Run npm install to pull the dependencies
3. Create a Firebase Admin sdk private key following the instructions in the Generating Firebase Key File and Database URL section below
4. In example.db.js file provide the path to your firebase key file and the database url
5. Run mongod to start running Mongo
6. Open another terminal without disturbing the terminal running mongod, then import the database with mongorestore --db dronesym dronedb/dronesym
7. Run npm start to start the Node server

Note: Make sure you have an admin account in the database under user collection. (Refer the schema in Models folder)

Part 2 - Setting up Python environment

1. After cloning the repo, navigate to the folder dronesym-python
2. Run sudo pip install -r requirements.txt to pull the dependencies
3. Navigate to dronsym-python/flask-api/src folder
4. Run python main.py to start the Flask server Note: Node server should be running when starting up the Flask server

Part 3 - Setting up the Angular front-end

Make sure that you have Node6.x or higher version installed

Install AngularCLI

$ npm install -g @angular/cli

Set environmental variable in ./dronesym-frontend/src/environments/environment.ts

Note: You will have to rename the example.environment.ts to environment.ts or create new file, for example by copying the example file:

$ cp src/environments/example.environment.ts src/environments/environment.ts`

mapsApiKey: 'YOUR_GOOGLE_MAPS_API_KEY',
nodeApiURL: 'http://localhost:3000/dronesym/api/node',
feedURL: 'http://localhost:3000/feed'

Note: Dronesym Node server (./dronesym-node/) and DroneSym Flask server (./dronesym-python/flask-api/src) should be running before starting the frontend server_

Starting the Angular2 development server

$ npm install
$ ng serve

Default login credentials

Admin

username: admin
password: admin

User

username: icarus
password: icarus

Part 4 - Running with Docker (Optional)

Checkout to docker branch

$ git checkout docker

Navigate to the root folder

Run

$ docker-compose up

Run Unit Tests Node

For node unit tests - both the flask server and node server have to be running.

Navigate to dronesym-node Run npm test

Generating Firebase Key File and Database URL

1. Sign into your google account and go to the Firebase Console page.
2. Add your project on then go to the settings panel for user credentials.
3. Generate and Download a new private key and move it to the same directory as the example.db.js file.
4. Open example.db.js and paste the name of the downloaded file into the creds = require line, as shown. Also, copy the database URL (looks like https://<database_name>.firebaseio.com) from the console and paste it in the databaseURL line, as shown.