Giter VIP home page Giter VIP logo

greennav's Introduction

GreenNav

This project aims to provide a reference implementation for a GreenNav (Green Navigation) front end. It makes use of the different react elements created for GreenNav.

Screenshot

Getting Started

Prerequisites

Install the latest version of Node.js and npm

sudo apt install nodejs npm

# optional:
# we recommend to set a symlink from nodejs to node
# if you get a command not found error
#
# sudo ln -s /usr/bin/nodejs /usr/bin/node

npm --version
3.10.8
node --version
v7.0.0

In some distributions Node.js and npm are a little bit outdated, but don't panik ๐Ÿ˜‰
you can use npm itself to update Node.js and npm to the latest versions.

sudo npm install -g npm
sudo npm install -g n

sudo n stable
# or
# sudo n latest

Setup

git clone https://github.com/Greennav/GreenNav.git
cd GreenNav
npm install

โ— Don't forget the back-end

We are currently working on new back-end in Java. Until then, there is a working demo that offers address search and routing functionality using Node.js.

git clone https://github.com/Greennav/rt-library.git
npm install
node demo-ucs.js

P.S.: Currently we only support the routing in Monaco

Run

npm start

The web interface is now accessible at http://localhost:3000/ by default, see your terminal for details.

Development

Git Workflow

  • Please fork the repository
  • Clone the webapp repository from your github account
git clone https://github.com/$(GITHUB_USER)/GreenNav.git
  • Create a new feature branch
cd GreenNav
git checkout -b your-feature
  • Make local changes and implement your feature
  • Push your branch to GitHub
  • Open a pull request

Code Quality

Please use eslint before contributing to the project. Consider using an editor-plugin like linter-eslint for Atom, ESLint for VS Code...

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

greennav's People

Contributors

tom3012 avatar marksurnin avatar maxlorenz avatar schoenfr avatar luvagarwal avatar jinankjain avatar elbartsch avatar theodor-eisen avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.