https://github.com/moumouls/data-toulouse-grapql
A (partial) GraphQL Support for the Toulouse Métropole Open Data service
https://github.com/moumouls/data-toulouse-grapql
api data graphql open service toulouse
Last synced: 30 days ago
JSON representation
A (partial) GraphQL Support for the Toulouse Métropole Open Data service
- Host: GitHub
- URL: https://github.com/moumouls/data-toulouse-grapql
- Owner: Moumouls
- Created: 2019-01-21T08:22:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-23T01:47:56.000Z (over 6 years ago)
- Last Synced: 2025-02-04T14:27:49.622Z (3 months ago)
- Topics: api, data, graphql, open, service, toulouse
- Language: TypeScript
- Size: 14.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Open GraphQL Toulouse
## What is GraphQL ?
`GraphQL` is a query language for APIs and a runtime for fulfilling those queries with your existing data. `GraphQL` provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
[Check GraphQL Specs](https://graphql.org)
## Why on Open Data ?
This project was created to facilitate the use of the service's data: `data.toulouse-metropole.fr`
`GraphQL` is a solution to solve the current problems of the APIs of this service such as :
- Lack of documentation
- The lack of ease of use of the global API
- The lack of consistency through the data
- Can't realize easy connections beetween Apis (Datasets)
To offer a quality and useful GraphQL API, only the APIs on the most "popular" datasets will be integrated!
## GraphQL Design
Each dataset has its own entry at the root of the `Graphql Server`
## Popular APis to Integrate
1. `Agenda des manifestations culturelles - Toulouse` : ⚠️
2. `Codes postaux de Toulouse` : ⚠️
3. `Chantiers en cours - Toulouse Métropole` : ⚠️
> Info
⚠️ : in progress
✅ : Operational
## Run the project
First of all get into the directory an run :
`npm i`
> Install all required packages
And then run :
`npm run start`
**Now the server run on `http://localhost:4004` and you can go to this url to play with the integrated `GraphQL PlayGround`**
## Dev on the project
Run : `npm i` before developing and then run : `npm run dev`
> The server restart automatically when you save files in `src` directory