Commit bdc6a836 authored by Adrien Pavie's avatar Adrien Pavie
Browse files

Created README (closes #1)

parent 3577c1e0
# P4CaaS
## Read-me
At start, [Pic4Carto](http://projets.pavie.info/pic4carto) is a website for browsing open-licensed, geolocated street pictures. From this website was extracted the core functionnality of retrieving pictures from several providers (Mapillary, OpenStreetCam, Flickr, WikiCommons...) as a JavaScript library called [Pic4Carto.js](https://framagit.org/PanierAvide/Pic4Carto.js), which can be integrated in various web applications.
To make reuse of pictures in various applications even easier, **P4CaaS** (Pic4Carto as a Service) was created here. It is a Rest API which can be called over HTTP requests for searching street pictures over all managed providers.
## Build & install
Before installing P4CaaS, you need to install some dependencies:
* npm
To launch your own Pic4Carto API, run the following commands:
```
git clone https://framagit.org/PanierAvide/P4CaaS.git
cd P4CaaS/
npm install
npm run start
```
Here you are, you can access the API through `http://localhost:3000/`.
## Usage
Just run HTTP queries over the API endpoint (by default `http://localhost:3000/`). Documentation can be accessed at `/doc`.
## Contributing
P4CaaS, as all over projects around Pic4Carto, is open source. Contributions are welcome, and here is how you can help for this project:
* Report bugs or discuss new functionalities in the [Issues tracker](https://framagit.org/PanierAvide/P4CaaS/issues).
* Write code (and tests) and create a [merge request](https://framagit.org/PanierAvide/P4CaaS/merge_requests). As this project is using [Git Flow branching model](http://nvie.com/posts/a-successful-git-branching-model/), please create requests on __develop__ or __feature/*__ branches.
## License
Copyright 2017 [Adrien PAVIE](http://pavie.info/)
See LICENSE for complete AGPL3 license.
P4CaaS is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
P4CaaS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with P4CaaS. If not, see <http://www.gnu.org/licenses/>.
......@@ -31,7 +31,7 @@
"dependencies": {
"body-parser": "^1.17.2",
"express": "^4.15.3",
"pic4carto": "^1.2.2",
"pic4carto": "^1.2.3",
"use-strict": "^1.0.1",
"xmlhttprequest": "^1.8.0"
},
......
......@@ -28,6 +28,7 @@ const express = require('express'),
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
app.use('/doc', express.static('doc'));
const routes = require('./api/routes/P4CaaSRoutes');
routes(app);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment