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

https://github.com/keplerjs/kepler-skeleton

KeplerJs Skeleton Quick Start Project
https://github.com/keplerjs/kepler-skeleton

boilderplate geosocial kepler-plugin keplerjs leaflet meteorjs mongodb nodejs

Last synced: 3 months ago
JSON representation

KeplerJs Skeleton Quick Start Project

Awesome Lists containing this project

README

        

# KeplerJs Skeleton Project

This repo gives you all you need to quickly create your working project based on KeplerJs

### One-Click Deploy a new instance on Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/Keplerjs/kepler-skeleton/tree/master)

### Deploy to your own server

Clone this repository
```
git clone [email protected]:Keplerjs/kepler-skeleton.git
cd kepler-skeleton
```
or in https:
```
git clone https://github.com/Keplerjs/kepler-skeleton.git
```

### Install dependencies and Run

```
npm install
npm start
```

### Customization

The best way to add, extend or modify features in KeplerJs is to create a [Kepler plugin](http://docs.keplerjs.io/plugin-js.html).
You can find in the documentation the guidelines for doing this.
Here there is also a skeleton of Kepler plugin inside the *packages* directory, it can be enabled or disabled through the standard Meteor commands *meteor add* or *meteor remove*:
```
meteor remove keplerjs:plugin-skeleton
```

A production instance is easily configurable as follow:
```
cp ./private/start.sh .
cp ./private/settings.sample.json ./settings.json
```
edits your custom mongodb database name *DBNAME="kepler_skeleton"* in the file *start.sh* and other [Kepler configurations](http://docs.keplerjs.io/configurations.html) in *settings.json*, run:
```
./start.sh
```

Default **.meteor/packages** content, uncomment for enable more plugins
```
keplerjs:base
keplerjs:theme
keplerjs:plugin-skeleton
#keplerjs:api
#keplerjs:edit
#keplerjs:admin
#keplerjs:stats
#keplerjs:upload
#keplerjs:share
#keplerjs:geoinfo
#keplerjs:osm
#keplerjs:favorites
#keplerjs:convers
#keplerjs:notifs
#keplerjs:pois
#keplerjs:tracks
#keplerjs:categories
```