Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 3.09 KB

README.md

File metadata and controls

48 lines (36 loc) · 3.09 KB
Raw

Build Status

ProxiMap

Proximap is a responsive web app written using Angular for finding nearby public infrastructure. Drinking fountains are used 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.

Running the project locally

Proximap requires a backend server (Datablue) to be running in order to display fountains.

  1. Requirements (make sure these are up to date)
  • NodeJS is a JavaScript runtime.
  • Git is a version control system you will need to have available as a command line executable on your path. A git integrated in your IDE will not be sufficient (and may cause issues).
  • Around 400-500MB of space on your disk. The project has development dependencies that are downloaded when you run > npm install (see point 3).
  • Angular CLI is a command line interface for Angular.
    • install Node first
    • Run > npm install -g @angular/cli to install globally
  1. Clone this repository to a local project directory
  • Run > git clone https://github.com/water-fountains/proximap.git -b develop.
  1. Open a command line in the local project directory
  • Install required node packages by running > npm install. If you update the project with > git pull, be sure to run npm > npm install again to update all packages.
  • Launch the server by running npm run start. You can view the application by navigating to http://localhost:4200. The app will automatically reload if you change any of the source files.

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.