Getting Ready

Foodsharing is mostly written in PHP and vue.js.

Requirements

• UNIX (or WSL)
• Git
• Node.js (20.16.0)
  • Newer versions can cause conflicts with the legacy code.
• Docker

INFO

To switch between Node.js versions on a UNIX system, you can use nvm.

Project structure

Details

Foodsharing
├── client
│   ├── lib
│   ├── src
│   │   ├── api
│   │   ├── components
│   │   ├── fonts
│   │   ├── helper
│   │   ├── mixins
│   │   ├── scss
│   │   ├── stores
│   │   └── views
│   └── test
├── docker
│   └── conf
├── migrations
├── scripts
├── translations
├── src
│   ├── Command
│   ├── Dev
│   ├── Lib
│   ├── Modules
│   ├── Permissions
│   ├── RestApi
│   └── Utility
├── templates
├── tests
│   ├── acceptance
│   ├── api
│   ├── cli
│   ├── functional
│   └── unit
└── websocket
    └── src

Start the local engine

Developing on a local basis requires a UNIX base system with docker installed.

WARNING

When you develop on Windows, WSL with Docker Desktop is required.

---

When you develop on Linux, Docker is required.

git clone git@gitlab.com:foodsharing-dev/foodsharing.git foodsharing
cd foodsharing && ./scripts/start

INFO

You need an ssh key on your system to clone the repository with SSH (set up guide).

Continue on Seed Overview.

Go mobile wild

A pre-configured Visual Studio Code, requires a GitLab account.

Open in Gitpod