otterDocs

Repository for Otterplan's engineering related guides

Getting Started

Requirements

• Docker
• Python 2.7
• Node 7.x.x
• Yarn
• A virtual machine, like VirtualBox

Repos

• OtterDB: Connect platform database
• OtterAPI: Connect Platform API Interface
• Vendor-Platform: Web Consumer App
• Bridal-Platform: Coming soon...

Setup

• Clone all the above repos
• Follow repo steps in order

OtterDB

Follow the docs but here are the basics

• Run Docker
• Navigate to your local OtterDB folder
• docker-machine create --driver virtualbox default
• docker-machine env default
• eval "$(docker-machine env default)"
• docker-compose up --build

Seed data

• coming soon...

Troubleshooting

• Check if your machine is running with docker-machine ls
• Restart your machine with docker-machine start default
• eval "$(docker-machine env default)"
• docker-compose up --build

otterAPI

Make sure otterDB is setup and running

• Runs on port 3000 so make sure it is free
• yarn install
• npm run start:watch

Vendor-Platform

Make sure both otterDB and otterAPI are up and running

• Runs on port 3020 so make sure it is free
• yarn install
• yarn start:dev

Bridal-Platform

Make sure both otterDB and otterAPI are up and running.

• Runs on port 3020 so make sure it is free (will collide with Vendor-Platform
• yarn install
• yarn start:dev