2017-04-26 21:55:26 -06:00
# <img align="left" src="/static/img/icon/by/48.png" alt="[]" title="The Tracman Logo">Tracman
2017-11-05 11:08:39 -07:00
###### v 0.7.12
2016-05-05 16:06:45 -06:00
2017-04-25 18:22:18 -06:00
node.js application to display a sharable map with user's location.
2016-04-27 22:02:13 -06:00
2017-12-12 17:40:07 -07:00
[![JavaScript Style Guide ](https://img.shields.io/badge/code_style-standard-brightgreen.svg )](https://standardjs.com)
2017-04-28 13:41:09 -06:00
2016-04-27 22:02:13 -06:00
## Installation
2017-03-18 13:53:48 -06:00
2017-05-02 03:57:10 -06:00
On unix-based systems:
2016-05-05 16:06:45 -06:00
```sh
2017-05-02 03:57:10 -06:00
git clone https://github.com/Tracman-org/Server.git & & \
mv Server tracman-server & & cd tracman-server & & \
exec npm install
2016-05-05 16:06:45 -06:00
```
2017-12-13 11:40:46 -07:00
You will need to set up a configuration file at `config/env/env.js` . Use `config/env/sample.js` for an example. You can get API keys at the [google developer's console ](https://console.developers.google.com/apis/credentials ). You will need to set up approved hosts and auth callbacks. There is more information in [their documentation ](https://support.google.com/googleapi/answer/6158857?hl=en ).
2017-04-26 21:13:14 -06:00
2017-12-13 11:40:46 -07:00
A good method is to simply copy the sample configuration and point `config/env/env.js` to the new version:
2017-04-26 21:13:14 -06:00
```sh
2017-06-23 09:30:05 -06:00
cp config/env/sample.js config/env/local-config.js
2017-06-27 10:03:06 -06:00
echo "module.exports = require('./local-config.js');" > config/env/env.js
2017-04-26 21:13:14 -06:00
```
2017-12-13 11:40:46 -07:00
Then edit `config/env/local-config.js` to match your local environment.
2017-03-18 13:58:57 -06:00
2017-04-28 13:41:09 -06:00
2017-04-26 21:26:46 -06:00
## Usage
2017-12-13 11:40:46 -07:00
Run Tracman with npm:
2016-04-27 22:02:13 -06:00
```sh
2017-08-22 18:52:48 -06:00
(npm run minify & npm run build) & & npm start
2016-05-12 21:10:34 -06:00
```
2017-04-26 21:26:46 -06:00
...or with [nodemon ](https://nodemon.io/ ):
2017-03-18 13:58:57 -06:00
```sh
2017-05-02 03:57:10 -06:00
npm run nodemon
2017-03-18 13:58:57 -06:00
```
2017-12-13 11:40:46 -07:00
Nodemon will automatically minify and bundle files and restart the app when you make changes. Check out the `nodemon.json` configuration.
2017-04-26 21:26:46 -06:00
2017-04-28 13:41:09 -06:00
2017-03-15 04:30:03 -06:00
## Contributing
2017-12-13 11:40:46 -07:00
Tracman will be updated according to [this branching model ](http://nvie.com/posts/a-successful-git-branching-model )... more or less. If you know anything about programming Android, [the Tracman android app ](https://github.com/Tracman-org/Android ) is more desperate for help.
2017-03-15 04:30:03 -06:00
2017-04-28 13:41:09 -06:00
2016-06-14 15:40:09 -06:00
## Changelog
2016-05-12 21:10:34 -06:00
2017-04-28 13:41:09 -06:00
[view full changelog ](CHANGELOG.md )
2017-12-12 17:40:07 -07:00
#### develop
* [#110 ](https://github.com/Tracman-org/Server/issues/110 ) Implemented [StandardJS ](https://standardjs.com/ )
2017-12-13 11:13:59 -07:00
* Removed emojis
2017-12-13 11:40:46 -07:00
* [#113 ](https://github.com/Tracman-org/Server/issues/113 ) [#114 ](https://github.com/Tracman-org/Server/issues/114 ) Switched to useMongoClient
* [#67 ](https://github.com/Tracman-org/Server/issues/67 ) Fixed invisible marker in demo
2017-12-13 12:52:01 -07:00
* Shortened if statements and long lines
2017-12-12 17:40:07 -07:00
2017-11-05 11:08:39 -07:00
#### v0.7.12
* Fixed altitude sign
#### v0.7.10
2017-09-27 20:24:56 -06:00
* Added coinhive
* Updated jQuery
* Added HTML5 shiv
2017-09-25 21:33:26 -06:00
#### v0.7.9
* Updated packages
* Added support for browser geolocation
* Fixed streetview image bugs
* Added sourcemaps for debugging
* Fixed streetview bearing
2017-09-16 20:37:52 -06:00
#### v0.7.8
2017-09-16 20:33:27 -06:00
* [#96 ](https://github.com/Tracman-org/Server/issues/96 ) Replaced panorama with static images
2017-09-16 20:37:52 -06:00
2017-09-16 16:48:32 -06:00
#### v0.7.7
2017-09-16 16:17:44 -06:00
* [#96 ](https://github.com/Tracman-org/Server/issues/96 ) Continue to update panorama after creating element
2017-08-22 18:10:17 -06:00
#### v0.7.6
* [#100 ](https://github.com/Tracman-org/Server/issues/100 ) Moved CSS out of webpack
* Fixed [#108 ](https://github.com/Tracman-org/Server/issues/108 )
2017-08-20 17:58:03 -06:00
#### v0.7.5
* Added pricing to homepage
2017-08-20 16:29:40 -06:00
#### v0.7.4
2017-07-14 16:12:06 -06:00
* Improved debugging
2017-08-20 16:29:40 -06:00
* Fixed bugs [#105 ](https://github.com/Tracman-org/Server/issues/105 ) and [#107 ](https://github.com/Tracman-org/Server/issues/107 )
2017-07-21 06:09:46 -06:00
* [#89 ](https://github.com/Tracman-org/Server/issues/89 ) Can change marker color
2017-07-14 16:12:06 -06:00
2017-07-14 15:50:22 -06:00
#### v0.7.3
* Fixed [#102 ](https://github.com/Tracman-org/Server/issues/102 ) issue creating account
2017-07-14 01:51:42 -06:00
#### v0.7.2
* Added more debugging to fix auth problems
2017-07-11 02:01:18 -06:00
#### v0.7.0
2017-09-25 21:33:26 -06:00
* Bug fixes
2017-04-13 23:12:59 -06:00
2017-04-12 12:40:56 -06:00
## License
2017-04-28 13:41:09 -06:00
[view full license ](LICENSE.md )
2017-04-12 12:40:56 -06:00
Tracman: GPS tracking service in node.js
Copyright © 2017 [Keith Irwin ](https://keithirwin.us/ )
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
2017-05-30 15:23:34 -06:00
You should have received a copy of the GNU General Public License along with this program. If not, see [http://www.gnu.org/licenses/ ](http://www.gnu.org/licenses/ ).