Frequently asked questions - what you can find here
- The architecture is not clear to me. Could you explain the basic layout?
- How do you start?
- What are our technical constraints? (such as server, storage. memory and communication interfaces)
- Are there visual guidelines? (User interface, colors, buttons, etc.)
- What are the security parameters? (i.e. how the website will ensure secure access control and transactions)
- So if we break the homepage down into its parts - how is it structured?
- What is the relationship between karrot and foodsharing currently?
- it-tasks lists a number of tech stuff we use on the page. How is their relationship to each other / what do we use them for?
- Who can I ask for help with what? Who is part of the team with which focus and which skills? (volunteer list)
Q: The architecture is not clear to me. Could you explain the basic layout?
A: The main architecture goals came from this book "Modernizing Legacy Applications In PHP", although we deviate in some place. There is also a great 1h video describing rough details about what the book is talking about.
A few current architecture goals would be:
- only 1 php entrypoint (
index.php), remove xhr|xhrapp.php/etc
- use symfony approach for handling all requests (some controllers do this already, others use the old way), in IndexController the
$isUsingResponseswitches behaviour based on that
- create REST controllers for all API use, remove all other API stuff
- use a symfony router or similar (might also involve changing page urls to nice paths instead of get parameters + adding redirects)
- have simple/general/default kind of symfony
index.phpfor templates/frontend stuff
- remove all html/js in php strings
- use vue.js for all dynamic kind of templates
- remove global eval stuff ... goes with the only REST API endpoints ...
- modernize a lot more of the frontend code
- replace years long outdated flourish lib
Q: I would really love to do anything, but when I look at the repo I can't even find a thing I could change just for testing! How do you start?
A: One technique is to
- find some text that is clearly visible on the page, and
- search the codebase for it, which might point to a translation string, then
- search for that translation key,
- repeat until finding it.
In foodsharing some of the longer content comes from the database, so you won't find that in the the codebase (except for maybe in an sql seed file), so try things more like buttons, or menu items...
Q: What are our technical constraints? (such as server, storage. memory and communication interfaces)
A: The server has 32G of memory, currently. Server stats:
The current email load is high, we get spam-flagged a lot, so in the future we need to introduce (more) granular email settings to users. (E-mail handling: we have currently more than one server for mails.) When we use a third party service, we sometimes run into problems (photon, map tiles).
Q: Are there visual guidelines? (User interface, colors, buttons, etc.)
A: There are guidelines. Basically, we use common sense.
The frontend needs rewriting as well and currently we're mostly working on & refactoring the backend.
... it could look like Karrot
Q: What are the security parameters? (i.e. how the website will ensure secure access control and transactions)
A: There were a lot of SQL injections. Now we use prepared statements, which is clearer. Vue helps against XSS attacks. (there might be legacy stuff lurking)
We're aiming for a point, where you get only the data you're requesting (Currently a lot of code is structured "if you're this or that, you get to see xy")
Q: So if we break the homepage down into its parts - how is it structured?
A: For some of the php code, see the php page.
Most of our functions can be found in
We still have some of the functions that bit by bit get replaced during refactoring.
A: karrot enables communities to do foodsaving - foodsharing is basically in german and has a lot of structures that some countries didn't want (thus e.g. minimizing the use of admins in the groups) ... the german-speaking organizational structures are kinda rooted in the code of foodsharing.
foodsharing is ALSO an organization.
karrot is a software project, the people who use it are their own organization, in a way.
Chandi showed how karrot and foodsharing might work together on the code base. (https://yunity.slack.com/archives/C1T1ZM9A4/p1577146381053600) For now, we're focusing on modernizing the codebase.
Q: it-tasks.html lists a number of tech stuff we use on the page. How is their relationship to each other / what do we use them for? What do we want to remove from our codebase?
A: We use ...
- PHP (Symfony 5) ... we also use a lot of non-symfony-php, that we want to refactor
- HTML (Twig) ... there is also the old way with string contatination. Twig is the new way. We're moving more towards vue.
- CSS (Bootstrap) ... move from global CSS to vuevue components
- MariaDB (which is basically MySQL) currently has a very lax error handling configuration. We try to set a more strict config here.
- Redis is also very low maintenancy. It's a cache, where the session is stored.
- socket.io nodejs server - the chat server. Low maintenance.
- RESTful APIs - We also have old ones but are moving towards REST.
- the Docker Compose development environment
- Codeception for Unit-, API-, and Acceptance testing (with Selenium) -
- GitLab CI for tests and automatic deployment (with php deployer) - this is a nice, stable setup through which multiple people can deploy stuff. (Not bottle-necking through one person as jobs are usually splitted between at least two servers.)
Q: Who can I ask for help with what? Who is part of the team with which focus and which skills? (volunteer list)
A: The common and most efficient way is to ask the dev channel a detailed question - so everyone who might have the knowledge and time can help.
Also we have team members with special responsibilities, see here: https://gitlab.com/foodsharing-dev/foodsharing/-/wikis/responsibilities
This means that there currently is no one head of the foodsharing IT. We decide with votes & vetos. Therefore currently there is no roadmap. The responsibles have lately said, that cleaning up old code and finishing open Merge Requests has priority over new features. But basically if you like an idea and are willing to work on your code - you're welcome to join. :-)