a responsive Angular 6 web app for finding nearby fountains
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status

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!

Supported cities

License

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

  • To use the last stable release: run git clone https://github.com/water-fountains/proximap.git -b stable.
  • To use the development release: run git clone https://github.com/water-fountains/proximap.git -b develop.

To install all project dependencies, run npm install within the project directory.

Launch a dev server

In the cloned repository directory, open a command window and run npm run start 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 npm run build to build the project. The build artifacts will be stored in the dist/ directory.

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
  • checkout the develop branch
  • create a new branch feature/[yourFeatureName]
  • make your changes and test them thoroughly
  • make a pull request

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