An open API service indexing awesome lists of open source software.

https://github.com/sephiroth7712/vidmapper


https://github.com/sephiroth7712/vidmapper

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# VidMapper

[![Hackathon](https://img.shields.io/badge/hackathon-Mumbai-orange.svg)](http://mumbaihackathon.in/)
[![Status](https://img.shields.io/badge/status-inactive-red.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/sephiroth7712/VidMapper.svg)](https://github.com/sephiroth7712/VidMapper/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/sephiroth7712/VidMapper.svg)](https://github.com/sephiroth7712/VidMapper/pulls)
[![License](https://img.shields.io/badge/license-GNU-blue.svg)](LICENSE.md)

# Table of Contents
+ [About](#description)
+ [Getting Started](#getting_started)
+ [Future Scope](#future_scope)
+ [File Structure](#file_structure)
+ [Contributing](#contributing)
+ [Authors](#authors)

## About
+ VidMapper is an Android/Desktop application developed to record and play geotagged videos.
+ Ability to export geographical data in KML format.
+ Cross-platform mobile (Android/iOS) and desktop(Windows/Linux/MacOS) applications.
+ Mobile application developed using Flutter.
+ Desktop application developed using Electron.js

## Getting Started

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.

### Prerequisites

What things you need to install the software and how to install them

Installing NodeJs
```
$ sudo apt-get install nodejs
```

If using a Windows based system, please refer to [Node.js](https://nodejs.org/en/download/) for futher steps.
To install Flutter please refer [Flutter](https://flutter.dev/docs/get-started/install) for further steps.

### Installing

A step by step series of examples that tell you how to start the Electron.js Desktop application

Cloning the repo
```
$ git clone https://github.com/sephiroth7712/VidMapper.git
```
#### Electron
Installing the dependencies
```
$ cd VidMapper
$ cd Electron
$ npm install
```
To start the application, use the following command:
```
$ npm start
```
The application will now start in a new window.

#### Flutter
Please refer to [Flutter](https://flutter.dev/docs/get-started/install) for further steps on how to import and run an existing Flutter project.

## Built With
+ [Electron.js](https://www.electronjs.org/) - Desktop Application Framework
+ [Flutter](https://flutter.dev/) - Mobile UI Framework

## Future Scope
+ Seeking through the video using the map interface.
+ Map view in livestreams.

## File Structure
/Electron : Main desktop application code

/Flutter : Main mobile application code

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request

## Authors

+ [Roshan James](https://github.com/sephiroth7712)

+ [Calden Rodrigues](https://github.com/caldenrodrigues)

+ [Chaitanyakrishna Dukkipaty](https://github/chaitanyadukkipaty)

+ [Kyle Lobo](https://github.com/kylelobo)

+ [Pratik Nerurkar](https://github.com/PlayPratz)

+ [Sarah Solkar](https://github.com/SarahSolkar)