Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-10 03:32:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add basic setup instructions

Browse Source
This commit is contained in:
Karl-Philipp Wulfert
2018-12-03 15:51:17 +01:00
parent b277d9fd39
commit f81be04e22
1 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
project-docs/SETUP.md Normal file
View File

@@ -0,0 +1,33 @@
# Basic setup for development
## Required tools/packages
* [SSH](https://docs.gitlab.com/ee/ssh/README.html)
* [Git](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html)
* [Docker](https://docs.gitlab.com/ee/user/project/container_registry.html) & Docker-Compose
* Node.js & NPM - be sure to install the current LTS version, might need a [PPA](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions)
* [NVM](https://github.com/creationix/nvm#installation) - if you want to use multiple different versions of node
```shell
apt install ssh git docker docker-compose nodejs
```
## IDE - recommended choices
* [Webstorm](https://www.jetbrains.com/webstorm/download/) - Free license for academic purposes
* [VSCode](https://code.visualstudio.com/)
## Optional helpful tools
* Curl - for executing HTTP requests
* Postman or Insomnia
## Clone starter repositories
* [Minimal deployment](https://gitlab.com/openstapps/minimal-deployment) - contains backend, database, minimal connector, copy (from api) and app
* [Minimal connector](https://gitlab.com/openstapps/minimal-connector) - an example connector to learn the principles of connector development
```shell
git clone git@gitlab.com:openstapps/minimal-deployment.git
git clone git@gitlab.com:openstapps/minimal-connector.git
```