Skip to content

huggla/origo

 
 

Repository files navigation

License Build Status

Origo

An easy to configure framework for creating your own web mapping applications.

What is Origo?

Origo is a web mapping framework. It is based on the OpenLayers library. You can use Origo to create your own desktop-like web mapping applications. The project is run and maintained by a number of Swedish municipalities.

Features

  • Responsive design
  • Multiple modules available (among others: an editing interface, geopositioning and map sharing)
  • Ability to read data from multiple different types of sources
  • Very light footprint

How to get started

Download the latest release and check out the documentation. Below you will find some live examples and how to get started devoloping with Origo.

Documentation

Learn more how to use Origo with the documentation.

Want to contribute?

We happily accept contributions of any kind. Guidelines are available in the CONTRIBUTING.md and DEVELOPING.md files.

Thank you for considering contributing to Origo.

Found an issue?

For all bugs and feature requests please use "Issues". Have a look at CONTRIBUTING.md for some tips on how to write issues.

Live examples

Not convinced? Or maybe you need some inspiration? Check out these examples of web maps that have been developed using the Origo framework:

Getting started

So you have decided to take matters into your own hands and get coding? Great!

Just follow these three steps and you will be up and running in no time.

Setting up the development environment

The minimum requirements are:

  • Git
  • Node.js (current lts version or higher is recommended to avoid build problems)
  1. To get your own local copy of Origo use git to clone the repository with the command below:

      git clone https://github.com/origo-map/origo.git
    
  2. To install the required node dependencies run the following command from the root directory of Origo:

       npm install
    
  3. To start webpack-dev-server use:

      npm start
    

The server will be available at http://localhost:9966/. It utilizes LiveReload which means you do not have to refresh the browser page whenever you make a change in your code.

Creating a bundle

Once you are ready to create a minified bundle, you will use:

 npm run build

This will create a build of Origo in the build folder. Note that you will need to change the path to the Origo javascript file in the index.html file, from origo.js to origo.min.js, if you wish to run the map using the bundled version.

To further reduce the bundle size of Origo it's recommended to enable gzip on your web server, as in this example for IIS. This will reduce the file size to approximately a fourth of the original size.

Notes

Guidelines for developing in Origo are available in the DEVELOPING.md file.

Plugins

More information about Origo plugins can be found in the PLUGINS.md file.

Copyright

The project is licensed under the BSD 2-clause license. It is specified in the license file.

Contact

If you want to get in contact with us and other users of Origo then please join our chat on discord using this invitation: origo.map.

On https://origo-map.github.io/archive/ you can take part of our newsletter and read about our meetups.

Packages

No packages published

Languages

  • JavaScript 94.2%
  • HTML 2.6%
  • CSS 2.1%
  • SCSS 1.1%