openstapps/project-docs/SETUP.md

Basic setup for development

Required tools/packages

• SSH
• Git
• Docker & Docker-Compose
• Node.js & NPM - be sure to install the current LTS version, might need a PPA
• NVM - if you want to use multiple different versions of node

Example for Debian based distributions:

apt install ssh git docker docker-compose nodejs

IDE - recommended choices

• Webstorm - Free license for academic purposes
• VSCode

Optional helpful tools

• Curl - for executing HTTP requests on the command line
• Postman or Insomnia - for executing HTTP requests with a GUI

Clone starter repositories

• Minimal deployment - contains backend, database, minimal connector, copy (from api) and app
• Minimal connector - an example connector to learn the principles of connector development

git clone git@gitlab.com:openstapps/minimal-deployment.git
git clone git@gitlab.com:openstapps/minimal-connector.git