README.md

vientos-sdk

Development environment for vientos stack, it includes as submodules:

• https://github.com/vientos/vientos-app
• https://github.com/vientos/vientos-service

dependencies

• npm (see: https://github.com/creationix/nvm)

optional

• mongodb or
• docker (see: https://www.docker.com/products/overview#/install_the_platform)
• docker-compose (see: https://www.docker.com/products/docker-compose)

usage

git submodule init && git submodule update

will checkout service and PWA

npm install

will install npm dependencies

cp env.example env
# edit env if needed
source ./env

if you don't have MongoDB, you can use on in docker container

docker-compose up -d

will start container with MongoDB in detached mode

vientos-service

cd vientos-service
npm install
cd .. # back to vientos-sdk

to start dev server for vientos-service

gulp service

git workflow

1. fork https://github.com/vientos/vientos-service on github
2. set your fork as remote in vientos-service

cd vientos-service
git fetch origin
git checkout staging
git remote add myfork [email protected]:{MYUSERNAME}/vientos-sdk.git

3. for each PR start from origin/staging, make topic branch and push it to your fork

git checkout staging
git pull origin
git checkout -b myfeature
# edit files and git add
git commit -m 'short description'
git push myfork myfeature

vientos-app

cd vientos-app
npm install
bower install
cp config.example.json config.json
# edit env if needed
cd .. # back to vientos-sdk

to start dev server for vientos-app

gulp app

git workflow

same as for vientos-service

full stack

to start both dev servers

gulp stack

testing

selenium

• http://webdriver.io/guide.html
  • http://docs.seleniumhq.org/download/
  • https://github.com/mozilla/geckodriver/releases