nav-e / nav-e.github.io Goto Github PK

Green Navigation is a prototypic system to compute energy-optimal routes and to predict the crusing range of electric vehicles. This repository contains the frontend and visualization tool for accessing the routing service. The aim of the project is both to provide users with optimal routes for electric vehicles and to provide researches with tools for evaluating their algorithms.

Home Page: http://greennav.github.io

HTML 76.88% CSS 16.61% JavaScript 6.52%

nav-e.github.io's Introduction

nav-e

This project aims to provide a reference implementation for a nav-e front end. It makes use of the different react elements created for nav-e.

TL;DR

Clone nav-e and routing
npm install and npm start for this repo
go get && go run main.go for routing
Chose Hector-Otto to Parc Princesse Antoinette from suggestions -> GET ROUTE
Contribute 😉

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

Get an API Key from the Google API Console

Location search and autocomplete is provided by Google Map's Javascript Library.

Step 1: Follow instructions on Google's Developer Documentation to register a project and get an unrestricted API key.

Step 2: Replace placeholder string in config.js with your generated API key.

Setup

git clone https://github.com/nav-e/nav-e.git
cd nav-e
npm install

❗ Don't forget the back-end

git clone https://github.com/nav-e/routing.git
cd routing
go get
go run main.go

To show a route, you have to pick a suggestion. Hector-Otto to Parc Princesse Antoinette is one example.

Run

npm start

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

Docker Setup

Docker allows packaging an application with all of its dependencies into a container.

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

Build

We will start by building a Docker image for the application (Dockerfile contains the command-line instructions).

docker build -t greennav-web-interface .

Run

Finally we run the image as a container, making the web interface available at http://localhost:3000/.

docker run -d --rm -p 3000:3000 --name greennav-web-interface greennav-web-interface:latest

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!

nav-e.github.io's People

Contributors

Stargazers

Watchers

Forkers

flow42 shrox pankajrandhe dinofelix sameeriitkgp unimauro marksurnin maxlorenz kyleamathews silky tom3012 rishav159 ar5had angelinagevenko jrios6 saumya-suvarna behnambahmani abhishek71994 rupal16

nav-e.github.io's Issues

Move to a static site generator

Make landing page editable in Markdown

Editing the index.js file is really inconvenient. Markdown should be preferred here

Interest in GSOC Projects

Hey guys @maxlorenz @maxlorenz @fabianbormann

I am very interested in a couple of the projects you've got going, specifically the Visualization tool and the Prototyping tool projects.

I'm from the United Kingdom currently on my industrial placement year at Smartzer. I studied at Aston University in my first year (and achieved the highest grades out of all first year CS students) before transferring to the University of Birmingham.

I gained a lot of experience programming in Java whilst at uni, and during the past 8 months I have primarily been helping to design and then programming front-end systems in JavaScript, JQuery, CSS and HTML. We're about to start re-implementing our systems using React for the front end.

Recently my team won 2nd place at a hackathon where I used Node.js and Socket.io and my teammate worked on the front-end to create a chatroom system with the idea of bringing all university systems (email, chat, assignments, exams, calendar, timetable, etc.) into one easy to use dashboard.

I would be very happy to discuss the projects and to discuss whether I'd be a suitable fit before submitting my proposal.

I hope you're having a great weekend!

Cheers,
Connor

Edit links

It would be nice, to have links for editing the pages on github - or at least link to get to the corresponding github repository. That way, it is easier to add information to the wiki.

Update Getting started wiki

The Getting started tab in wiki mentions Setup.md which has the setup instructions of the the deprecated fronted also the README.md file in that repo leads to the Webapp which has the the instructions to set up the newer frontend. Content of README of Webapp repo can be put into the Setup.md which will help the newcomers to get the correct setup instructions.