Skip to content
Repository for Mapa project
JavaScript TypeScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook
goodmap-core
goodmap-webapp
spec
src
.babelrc
.eslintrc.js
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
karma.conf.js
package-lock.json
package.json
screenshot.jpg
webpack.config.babel.js

README.md

Demo: https://mapa.falanster.by/

Development

BrowserStack Status Build Status 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.

Dependencies

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

Now clone this repository:

git clone https://github.com/diglabby/mapa

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

cd goodmap-old/
npm install

or yarn

Local development setup

The easiest way to get a local setup running is by using the remote API of OpenFairDB. To do so change src/constants/URLs.js to https://github.com/goodmap/goodmap-old/blob/e9658f1d2a8d77effe4cfabc085b5c7a2c65c3f3/src/constants/URLs.js#L64

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
//    link: window.location.protocol + "//" + "dev.ofdb.io/v0" //if you want to work with development environment

}

The alternative is to run OpenFairDB Server locally:

####Linux setup:

wget https://download.ofdb.io/openfairdb-x86_64-linux-v0.3.1.tar.gz
tar xzf openfairdb-x86_64-linux-v0.3.1.tar.gz
./openfairdb

openfairdb should now be listening on port 6767.

To actually get started you also need to add some content. (Save database, copy it to local repository, unzip and override the previous database).

####Docker setup:

  1. Clone the openfairdb repo.
  2. Go to openfairdb folder: cd ./openfairdb
  3. Build image and run the container by commands from openfairdb repo
  4. openfairdb should now be listening on port 6767.

Get the web app running:

    cd /path/to/goodmap-old/
    npm start

or

    yarn start

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

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

npm t

Backend

KVM uses the OpenFairDB as its backend.

Goodmap

<3 Goodmap Consortium

Core

  • Navigate to goodmap-core folder
  • Add changes
  • Recompile by using yarn build

Webapp

  • Navigate to goodmap-webapp folder
  • Install via yarn install
  • Add changes
  • Run by using yarn start

License

Copyright (c) 2015 - 2018 Markus Kohlhase mail@markus-kohlhase.de This project is licensed under the AGPLv3 license.

You can’t perform that action at this time.