abdellahrk/cameroon-open-data

This project is for the Cameroon Open Data initiative to enable data on Cameroon be available to the public. # Open Data for Cameroon This project is aimed to be a central hub for all public data in Cameroon. It's open for contributions by any party. The project kicks off just with the API version where data can be accessed through endpoints e.g `base-url` and a sample response of ``` "title": "Regions", "description": "The list of all regions in Cameroon and their capitals with other useful information\n", "data": { "regions": { "name": "Adamawa", "capital": "Ngaoundere", }, { "name": "Centre", "capital": "Yaounde" }, { "name": "East", "capital": "Bertoua" }, ... } } ``` This will be very useful for anyone building anything and requires this data to access it easily. People can even build their project relying on it as one source of data. ## Stack The project is built with PHP and the Symfony framework. Knowledge of `YAML` is required if contributing on data. More on [`YAML` at yaml.org ## Getting Started ### Symfony Binary 1. Clone the project locally 2. Install dependencies with Composer - `composer install` (more on Composer at composer.org) 3. Run the Symfony web server `symfony server:start -d` or point to any virtual host you use ### Docker 1. If not already done, install Docker Compose (v2.10+) 2. Run `docker compose build --no-cache` to build fresh images 3. Run `docker compose up --pull always -d --wait` to set up and start a fresh Symfony project 4. Open `localhost` in your favorite web browser and accept the auto-generated TLS certificate 5. Run `docker compose down --remove-orphans` to stop the Docker containers. ### Contributing - You can contribute with data-We greatly need this and we appreciate your time and efforts-in the directory `data`, you can create a `yaml` file depending on the data you want to contributing e.g `restaurants.yaml`. Check yaml.org for markup instructions - You can also contribute by improving the code. More endpoints will have to be created depending on the data available. 1. Code has been simpli …