Metabolism of Cities: Resources and tools for the Metabolism of Cities website
CSS JavaScript PHP HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
apis
assets
css
fonts
img
import
js
login MOOC registration 20 Nov 25, 2017
materialstock
questionnaire
xcf
.gitignore
.htaccess
404.php
CHANGELOG.md
LICENSE
README.md
about.php
abstracts.get.php
abstracts.grep.php
access.php
admin.add.php
admin.indicator.php
admin.indicators.php
ajax.contact.php
ajax.media.php
ajax.php
analysis.case.php
analysis.edit.php
analysis.options.php
blog.php
casestudies.php
casestudy.edit.php
casestudy.php
city.php
class.db.php
cms.author.php
cms.blog.php
cms.blogauthorlist.php
cms.bloglist.php
cms.dataviz.php
cms.datavizlist.php
cms.index.php
cms.log.php
cms.mail.php
cms.mailssent.php
cms.masstags.php
cms.media.php
cms.module.php
cms.modules.php
cms.mooc.php
cms.moocmedia.php
cms.moocquestion.php
cms.moocquestions.php
cms.moocs.php
cms.people.php
cms.peoplelist.php
cms.plaintags.php
cms.tag.php
cms.tagparents.php
cms.tags.php
cms.video.php
cms.videolist.php
cms.votes.php
cms.voteslist.php
cms.wishlist.php
cms.wishlistitem.php
collaborators.php
composer.json
composer.lock
config.sample.php
contact.php
content.php
data.add.php
data.categories.php
data.export.php
data.php
datavisualizations.php
dataviz.callforcollaboration.php
dataviz.examples.all.php
dataviz.examples.php
dataviz.links.php
dataviz.records.php
debug.php
documentation.1.php
documentation.2.php
documentation.3.php
documentation.4.php
empty.admin.php
empty.omat.php
empty.php
favicon.ico
functions.cms.php
functions.mail.php
functions.omat.php
functions.php
functions.profile.php
humans.txt
iceland.csv
import.eurostat.php
import.iceland.php
import.php
include.cmsheader.php
include.cmstags.php
include.editor.php
include.footer.php
include.header.php
include.news-aside.php
include.omatfooter.php
include.omatheader.php
include.profilefooter.php
include.profileheader.php
include.search.php
index.epr.php
index.php
journals.php
keywords-jie.php
links.php
load.epr.sql
load.sql
login.php
mailinglist.php
maintenance.activities.php
maintenance.activity.php
maintenance.contact.php
maintenance.contacts.php
maintenance.dqi-indicator.php
maintenance.dqi-score.php
maintenance.dqi-section.php
maintenance.dqi.php
maintenance.industrysize.php
maintenance.industrysizes.php
maintenance.scale.php
maintenance.scales.php
maintenance.source.php
maintenance.sources.php
maintenance.tag.php
maintenance.tags.php
map.csv.php
map.php
mission.php
mooc.download.php
mooc.php
mooc.register.php
news.feed.php
news.php
omat.about.php
omat.activity.php
omat.add.php
omat.contact.php
omat.contacts.php
omat.create.php
omat.dashboard.php
omat.data-delete.php
omat.data-point.php
omat.data.php
omat.datagroup-entry.php
omat.datagroup.php
omat.dataset.php
omat.documentation.php
omat.download.php
omat.file.php
omat.files.php
omat.filters.php
omat.indicator-list.php
omat.industries.php
omat.industry.php
omat.industrycomparison.php
omat.list.php
omat.load-eurostat.php
omat.log.php
omat.manage.php
omat.material-comments.php
omat.material-entry.php
omat.materiallink.php
omat.population.php
omat.print.php
omat.projectinfo.php
omat.projects.php
omat.sankey.php
omat.sankeynodes.php
omat.sankeys.php
omat.settings.php
omat.source.php
omat.sourcedetails.php
omat.sources.php
omat.transport.php
omat.viewactivity.php
omat.viewcontact.php
omat.viewindustry.php
omat.viewsankey.php
omat.viewsource.php
people.php
profile.case.php
profile.dashboard.php
profile.data-entry.php
profile.data.php
profile.edit.php
profile.logout.php
profile.php
profile.publications.php
publication.alt.php
publication.altview.php
publication.edit.php
publication.view.php
publications.add.php
publications.collections.php
publications.export.php
publications.list.php
publications.php
publications.results.php
publications.search.php
register.php
reports.activities.php
reports.data.php
reports.dataoverview.php
reports.export.php
reports.graph.php
reports.graphs.php
reports.indicator-formula.php
reports.indicator.php
reports.indicators.php
reports.sources.php
reports.table.php
reports.tables.php
reports.travel.php
research.add.php
research.list.php
research.php
researchmap.csv.php
robots.txt
sample2.html
sitemap.php
stakeholders.data.php
stakeholders.masterclasses.php
stakeholders.php
stakeholders.subscribe.php
starterpack.php
submit.php
team.php
temp.php
template.xlsx
upload.php
version.php
video.php
videos.php
vote.php
wishlist.php

README.md

How to run this site on your own server

Requirements

  • PHP 5.3.5 +
  • Recent version of MySQL
  • Recent version of Apache
  • Linux is fully supported; Windows support may be lacking but is likely no problem

Getting started

First, clone this repo as per Github instructions. Are you new to Git and/or Github? Fear not! Github has a friendly help section where you can go to for more information.

Once you have the repo on your machine, put this in the webroot of your Apache server, and you should be able to navigate there using http://localhost/mfa-tools, or something similar. You will see an error about not having a config file - you're ready for the next step!

It's time to set up the database. Create a new MySQL database, and load the database structure. You can find this structure in load.sql. Please note that this structure does not contain any data. If you want to load the publications and other data from the website, request a copy of the most current database from one of the current maintainers.

Once your database is loaded, open the config.sample.php file and adjust this for your own situation. Save this as config.php (don't overwrite config.sample.php!) and navigate again to the local URL. If all went well, you will now see the MFA Tools website!

File uploads

In order for file uploads to work (OMAT has an option to upload files for each source), be sure to create the 'files' directory (or whatever you called it in your config file), and to give the Apache user permissions to upload files there. If you have a fork of MFA Tools operating in production, then make sure you place this folder outside of your webroot!

How to contribute to this project

What to work on?

In principle you can work on anything you like! However, we have a Wish List with a variety of features that are wanted. Any of those features will be greatly appreciated, but you can also work on other functionality if you so prefer. You may want to check in upfront with the developers before initiating something radically different or out of the current scope.

Coding Standards

We follow the Pear Coding Standards with one main exception: we use 2 space indentation instead of 4 space indentation! Other than that, try to stick to the Pear Coding Standards. If you deviate too much, you may be requested to reformat your code before it is accepted.

Git workflow

Read through the Github article on the Git workflow if you are not too familiar with how Git works. Normally, you do not need to make a branch unless you are working on a large change or big featureset. Smaller changes can be committed directly onto the Master branch. Just ensure that you work off the most recent version as the codebase can be rapidly changing. If your changes will take several days of coding to complete, then do create a branch to avoid merging conflicts - especially if it concerns code others may also be working on.

File and URL naming conventions

Look at current files and URLs to get an idea. If in doubt, check in beforehand.

Versioning of the website

We provide a "Version" number for the website. Every month we'll increment the version with 0.1 if changes were made. In order to have a good overview of the changes, please add the changes you made to the CHANGELOG file. These changes will be accumulated on a monthly basis and placed online when the new version is 'launched' (do note that in reality new versions are introduced on a rolling basis, at any time, but for easy public perception the site is 'versioned' and changes are grouped this way).