Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/patrickrobrecht/kirchen-im-web

Directory of Churchy Websites and Social Network Pages
https://github.com/patrickrobrecht/kirchen-im-web

church-website churches social-media social-network social-network-analysis

Last synced: 10 days ago
JSON representation

Directory of Churchy Websites and Social Network Pages

Host: GitHub
URL: https://github.com/patrickrobrecht/kirchen-im-web
Owner: patrickrobrecht
Created: 2016-05-22T17:25:19.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2024-09-29T10:24:19.000Z (about 1 month ago)
Last Synced: 2024-10-10T02:22:22.677Z (28 days ago)
Topics: church-website, churches, social-media, social-network, social-network-analysis
Language: PHP
Homepage: https://kirchen-im-web.de
Size: 2.18 MB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        ![Screenshot](public/images/screenshot.png)

[README in Deutsch](./LIESMICH.md)

# [kirchen-im-web.de](https://kirchen-im-web.de/en/) - Directory of Churchy Websites and Social Network Pages 

We want to show that many parishes, regional churches and dioceses

    do a good job in public relations 

    and present those with their websites and social network pages 

    [at a map](https://kirchen-im-web.de/en/map/) and 

    [tabularly](https://kirchen-im-web.de/en/search/).

kirchen-im-web.de also compares the follower numbers of the

    [social media pages](https://kirchen-im-web.de/en/comparison/).

Our Project is oecumenic, i. e. regardless whether Protestants, Catholic or free church - all can participate.

You can simply add your church using our [form](https://kirchen-im-web.de/en/add/).

## Features

* [map](https://kirchen-im-web.de/en/map/)

    with all churches which can be filtered according to denomination and network

* [table](https://kirchen-im-web.de/en/search/) and [social media comparison](https://kirchen-im-web.de/en/comparison/)

    with filtering according to name, postal code, city, country, denomination, type, network

* [details page](https://kirchen-im-web.de/en/details/1/)

    for every church showing all websites and networks, map and church hierarchy

    and offering download of the social media follower history

* form to [add new churches](https://kirchen-im-web.de/en/add/)

* [statistics](https://kirchen-im-web.de/en/statistics/)

    and downloadable [open data](https://kirchen-im-web.de/en/data/)

* available in English and German

## Link check and follower update

The script `cron.php`

- checks whether the listed websites are still online

- and updates the follower count of the listed social media accounts.

    Non-public pages can be excluded via `followerStatus = 2`.

`followerStatus = 0` means that the last follower update failed.

## API Documentation

kirchen-im-web.de offers the data via a public API at `https://kirchen-im-web.de/api/` which returns all the data on the selected churches in JSON format. Even if there is only one result for the query, the data is returned as a list.

### GET /api/churches/

Per default, the whole data is returned in [JSON](https://www.json.org/).

Parameters can be used to reduce the number of entries which are returned.

Example: A call to `https://kirchen-im-web.de/api/churches/?name=test` only returns data of the churches whose name contains the string `test`.

Supported parameters:

* `ids` (optional):

    entry ids (multiple ids can be separated by comma)

* `parent` (optional):

    only children of the given parent id

    (`options` allow to include the parent itself and grandchildren)

* `name` (optional):

    the substring of the name

* `postalCode` (optional):

    the postal code

* `city` (optional):

    the substring of the city

* `country` (optional):

    the country code (e. g. `DE` for Germany).

	Possible values: see `$countries` variable in the [configuration file](./src/Helpers/Configuration.php)

* `denomination` (optional):

    the denomination.

	Possible values: see `$denominations` variable in the configuration file

* `type` (optional):

    the type.

	Possible values: see `$types` variable in the configuration file

* `hasWebsiteType` (optional):

    the website type.

	Possible values: see `$websites` variable in the configuration file

* `options=includeSelf,recursive` (optional):

    * If `parent` is given and `options` contains `childrenRecursive`,

        the grandchildren are also included in the response.

    * If `parent` is given and `options` contains `includeSelf`,

        the parent is included in the response.

### GET /api/churches/{id}/

The data of the church with the given id is returned in JSON.

The entry id is the number in the URL of the details page.

### GET /api/churches/{id}/children/

Returns the (direct) children of the church with the given id in JSON.

### GET /api/churches/{id}/followers/

Returns the follower history for the social networks of the church in csv or JSON.

* `type`: csv or JSON (default)

## How to develop

### Requirements

* [Apache](https://httpd.apache.org/) 2.4+

* [PHP](https://secure.php.net/) 8.1+

* [MySQL](https://dev.mysql.com/downloads/) database

* [npm](https://www.npmjs.com/) 9+

* [Composer](https://getcomposer.org/) 2+

### Setup

* Clone the Git repository.

* Install the dependencies via `composer install` and `npm install`.

* Run `npm run watch` to automatically compile `*.scss` to `*.css` 

    and `*.js` to `*.min.js` whenever the file is changed.

* Create a database and create the tables with `database-scheme.sql`.

* Create a `config/config.php` with the database credentials and valid API keys/secrets

    (cp. `config/config.sample.php`).

### Code Style Guidelines

- CSS: recommended configuration for [stylelint](https://stylelint.io/)

    - `npm run csCSS` to run a check for compliance with the guidelines

    - `npm run fixCSS` applies fixes for violations automatically.

- JavaScript: [JavaScript Standard Style](https://standardjs.com/rules.html),

    checked by [eslint](https://eslint.org/)

    - `npm run csJS` to run a check for compliance with the guidelines

    - `npm run fixJS` applies fixes for violations automatically.

- PHP: [PSR12](https://www.php-fig.org/psr/psr-12/)

    - `composer csPHP` to run a check for compliance with the guidelines

    - `composer fixPHP` applies fixes for violations automatically.

To run all checks, use `composer cs`.

## Used programming languages and libraries

* [HTML and CSS](https://www.w3.org/standards/webdesign/htmlcss),

    based on [Bootstrap](https://getbootstrap.com/)

* [PHP](https://secure.php.net/) with libraries

    [Facebook Graph SDK](https://github.com/facebookarchive/php-graph-sdk),

    [Instagram PHP Scraper](https://github.com/postaddictme/instagram-php-scraper),

    [OpenCage API](https://github.com/OpenCageData/php-opencage-geocode),

    [Slim](https://www.slimframework.com/),

    [Symphony Translations](https://symfony.com/doc/current/translation.html),

    [Twig](https://twig.symfony.com/)

    and [twitter-api-php](https://github.com/J7mbo/twitter-api-php)

* JavaScript, especially the libraries

    [Highcharts](https://www.highcharts.com/),

    [Leaflet](https://leafletjs.com/) and 

    [tablesort](https://github.com/tristen/tablesort)

## How to deploy

- Run `npm run production`.

- Run `composer install --optimize-autoloader --no-dev`.

- Upload the following to the production server: 

    - the directories `config`, `public`, `src`, `resources`, `vendor`, and

    - the file `cron.php`.

- Create empty directories `cache` and `data`.