# ngeo

ngeo is a JS library that aims to ease the development of applications based on AngularJS and OpenLayers.

More specifically, ngeo is a collection of AngularJS Components and Services useful for developing applications combining AngularJS and OpenLayers.

Ngeo uses webpack: webpack gives you the possibility to use easily only the specific part of JavaScript, css and html that you need for your application.

If you use ngeo we recommend that you also use webpack, because this is the way we design and use ngeo at Camptocamp. But using webpack is not strictly mandatory: standalone builds of ngeo can be created.

To know more about ngeo take a look at:

- The examples
- The simple API help
- The documentation can be found in each file. There is currently no API web-documentation for this version (you may also use API documentation).

ngeo also includes a contribs directory where non-core contributions may be placed. ngeo currently includes one contrib: `gmf`. That contrib includes components specific to the GeoMapFish project, that is components that rely on GeoMapFish-specific web services. The `gmf` contrib examples are also available online.

## Requirements

- make – GNU Make.
- node – nodejs JS runtime environment.
- npm – npm package manager.

## How to start

### Run the application

    git clone git@github.com:camptocamp/ngeo.git
    cd ngeo
    make serve-ngeo

The ngeo examples are now available on your https://localhost:3000/examples/.

### Run GeoMapFish

To run the GeoMapFish examples:

    make serve-gmf

then visit https://localhost:3000/contribs/gmf/examples/.

To run the GeoMapFish applications:

    make serve-gmf-apps

then visit them using https://localhost:3000/contribs/gmf/apps/<app_name>.html, for example: https://localhost:3000/contribs/gmf/apps/desktop.html

### Run the Simple API Help

To run the Simple API Help:

    make serve-api

Then visit https://localhost:3000/apihelp.html

### Go further

- Developer guide – This guide is for ngeo developers.
- Application development guidelines – This guide is for application developers using ngeo.

## How to migrate from ngeo 2.2 to ngeo 2.3 ?

- The migration guide - from 2.2 to 2.3 – This guide is for integrators still on ngeo 2.2 and wanting to use ngeo 2.3.

## Other docs related to ngeo:

- Transifex – Translation platform.
- Travis – Continuous integration.

Generated using TypeDoc