a responsive Angular 6 web app for finding nearby fountains
Clone or download
Pull request Compare This branch is 101 commits behind water-fountains:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
code
docs
.gitignore
COPYING
README.md

README.md

ProxiMap

Proximap is a responsive web app for finding nearby public infrastructure, and uses drinking fountains as a showcase example. It is being developed in conjunction with Datablue, a tool for collecting, aggregating, and serving fountain data from Open Street Map, Wikidata, Wikimedia Commons, and Wikipedia. Check out water-fountains.org for more information on the overall project, and beta.water-fountains.org to see a beta version of the app!

The project is open source under the GNU Affero General Public License, with a profit contribution agreement applying under restricted conditions. See COPYING for information.

Up and running

Requirements

  • NodeJS
  • Angular CLI: after NodeJS is installed, open a command window and run npm install -g @angular/cli

Get the files and dependencies

Clone this repository to your computer, open a command window in the directory you cloned to, change to the code/ directory and run npm install.

Launch a dev server

In the code/ directory, open a command window and run ng serve to launch a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. If the app fails to display in the browser, run ng serve -prod instead.

Build the project

Run ng build from the code/ directory to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Extract and generate translations

html tags can be marked for translation with the i18n attribute. Extract strings for translation with ng xi18n. Follow instructions here to create translation files, and then use the CLI to serve or build the project in the alternative languages: ng serve --aot --i18nFile=src/locale/messages.de.xlf --i18nFormat=xlf --locale=de

Testing

We use BrowserStack to test design concepts and user experience for iOS and Android devices. BrowserStack logo

Contributing

Submit an issue for a feature request, architecture suggestion, or to discuss a modification you have made or would like to make.

If you would like to contribute directly to the code, fork this repo and make a pull request.

To get ideas for how to contribute, see open issues.