Skip to content
This repository was archived by the owner on Sep 24, 2019. It is now read-only.

Technical documentation

Hendrik tol edited this page Jan 15, 2018 · 3 revisions

✨ Technical documentation✨

✍️ introduction

This document describes the technical specifications of Statman. For information about test environments and best practices you can take a look at our wiki.

⚙️ Backend

Statman's backend is built using php 7.0 in combination with the framework Laravel (5.4). Our database solution is currently MySQL, however we are convinced that Graph would be a good competitor to this solution.

MYSQL UML

🔗 API's

Statman uses the following API's:

  • Facebook API
  • Instagram API

both of these API's are currently in a development environment, because we do not meet the standards of using the deployment versions of the API's.

Facebook API

Facebook's API is used to allow the user to use Facebook pages they manage in the application. We make certain calls to allow us to showcase post information to the user. In order to get access to this information we use the authentication within the Facebook API, this can be found on the Facebook API documentation.

Instagram API

Statman uses the Instagram API in order to showcase post information to the user. In order to get access to the Instagram API you have to be invited as a sandbox user and allow the application on Instagram. In order to grant access to our application we use OAuth 2.0.

🛠️ Object oriented programming

In the past half year, a different development team has taken conrol over Statman, this also includes a different way of working. The new team focusses on object oriented programming. This means that for any new feature added, the model will handle the objects within the database and the controllers handle the gathering and translation of the data to be displayed on the frontend. Due to the base that the previous development team left, the code is inconsistent when it comes to this. We had the intention to fix this but due to internal connections and the timespan given to us for this project we decided to leave the code that works and use our new standard on any new features we add.

Clone this wiki locally