Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kartevonmorgen/kartevonmorgen

This is the Alpha version (v0) of Karte von morgen. Please contribute to our new project in TypeScript (v1) https://github.com/kartevonmorgen/kartevonmorgenssr
https://github.com/kartevonmorgen/kartevonmorgen

geo karte-von-morgen kvm map map-von-morgen openfairdb openstreetmap sustainability

Last synced: 5 days ago
JSON representation

This is the Alpha version (v0) of Karte von morgen. Please contribute to our new project in TypeScript (v1) https://github.com/kartevonmorgen/kartevonmorgenssr

Awesome Lists containing this project

README 

        
# Karte von morgen



![Screenshot](https://raw.githubusercontent.com/kartevonmorgen/kartevonmorgen/master/screenshot.jpg)



## Mapping for Good



von morgen supports kindness, sustainability and joint action.

Everything that brings a little happiness to our world.

We believe that living in a de‐stressed, environmental‐friendly and

trust‐worthy society, is already in progress.

We want to support people in finding ways to embrace those values.



The Map von morgen is a website and app, that allows users to share their

favorite places in the world. Places that are forward‐thinking and inspiring.

The goal is to collect projects, companies and events that make a world of

tomorrow, already experienceable today.



Website: [https://kartevonmorgen.org/](https://kartevonmorgen.org/)



## Development



[![Build Status](https://secure.travis-ci.org/kartevonmorgen/kartevonmorgen.svg?branch=master)](http://travis-ci.org/kartevonmorgen/kartevonmorgen)

[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat)](https://github.com/kartevonmorgen/kartevonmorgen/blob/master/LICENSE)



Are you're interested in contributing to KVM?

The following is a description of a quickstart.

If you're looking for a more comprehensive introduction,

have a look at [CONTRIBUTING.md](CONTRIBUTING.md).



### Dependencies



To be able to start development you'll need the following tools:



- [git](https://www.git-scm.com/)

- [Node.js](https://nodejs.org/) version 8.x

- [yarn](https://yarnpkg.com/getting-started/install) version 1.x

- [OpenFairDB](https://github.com/kartevonmorgen/openfairdb) version 0.7.x



Now clone this repository:



```sh

git clone https://github.com/kartevonmorgen/kartevonmorgen

```



Go to the root of it and install all the dependencies:



```sh

cd kartevonmorgen/

yarn install

```



### Build



To build the web application run:



```sh

yarn run pack

```



The result can be found in `dist/`.



#### Deployment to another URL than www.kartevonmorgen.org



running



```sh

yarn run pack-beta

```



will automatically use https://api.ofdb.io as API url (instead kartevonmorgen.org/api - which will only work when also deploying to production).



### Development



You may either use a remote instance of the OpenFairDB server or start your

own instance locally.



#### Remote OpenFairDB server



The easiest way to get a local setup running is by using the remote API of [OpenFairDB](https://github.com/kartevonmorgen/openfairdb).

To do so change `src/constants/URLs.js` to



``` js

OFDB_API: {

    //link: window.location.origin + "/api" //use when you run openfairdb locally

    link: window.location.protocol + "//" + "api.ofdb.io/v0" //use this to use the remote api

}

```



Don't forget to skip those changes later when comitting or revert them before

starting a local server instance as described next!



#### Local OpenFairDB server



The alternative is to run [OpenFairDB](https://github.com/kartevonmorgen/openfairdb) server locally.

A static executable for all recent versions is available on the

[OpenFairDB *Releases*](https://github.com/kartevonmorgen/openfairdb/releases) page.



Download, unpack and run (on Linux):



```sh

wget https://github.com/kartevonmorgen/openfairdb/releases/download/v0.5.5/openfairdb_v0.5.5.x86_64-unknown-linux-musl.tar.xz

tar xJf openfairdb_v0.5.5.x86_64-unknown-linux-musl.tar.xz

RUST_LOG=info ROCKET_PORT=6767 ./openfairdb

```



`openfairdb` should be listening on port 6767. Stop the server for finishing the initial setup.



##### Database setup



The file `openfair.db` with an empty SQLite3 database has been created during the first startup

in the current working directory. This empty database needs to be populated with 3 categories

that are referenced from the frontend by their ids.



For this purpose start your favourite SQLite3 management tool, open the *openfairdb.db* file

and execute the SQL statements in

[res/init_openfairdb_categories_de.sql](res/init_openfairdb_categories_de.sql). You can also accomplish

this task with the SQLite CLI tool:



```sh

sqlite3 openfair.db < res/init_openfairdb_categories_de.sql

```



The actual names of the categories in the database do not matter, but you may translate them

into your preferred language.



Now restart the server again and keep it running in a terminal to monitor the logs:



```sh

RUST_LOG=info ROCKET_PORT=6767 ./openfairdb

```



#### Web app



Get the web app running:



```sh

cd /path/to/kartevonmorgen/

yarn start

```



The web app is now listening on port 8080. Open it in your browser `https://localhost:8080`.

Ignore the security warning that is caused by a self-signed certificate in the local proxy.



On every file change in `src/`, the app will be build

for you and the browser reloads automatically.



### Tests



All the tests can be found in the `spec/` folder.

To run the tests type



```sh

yarn test

```



### Backend



KVM uses the [OpenFairDB](https://github.com/kartevonmorgen/openfairdb) as its backend.



## License



This project is licensed under the [AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.txt).