3.8 KiB

Raw Blame History

HOW TO CONTRIBUTE

Fork the official Farmbot Master branch
Set up a development environment
Make your changes.
Run tests, make sure you didn't break anything.
Create a pull request to the official Farmbot Master Branch
Provide a detailed description of what changed.

Development

The project is developed in Elixir, and builds a full Linux operating system. That being said, you will need Linux, or a Linux Virtual Machine to build the system. The following assumes you are on a Ubuntu Based distribution. When building code for the OS (this project) you will NEED the rest of the stack set up locally.

Note

A vagrant file would be greatly appreciated.

Upon completion you will have the following folder structure:

farmbot
├── farmbot_web_api
├── farmbot_mqtt_broker
├── farmbot_web_frontend
└── farmbot_os

Dependencies

sudo apt-get update
sudo apt-get upgrade
sudo apt-get -y install build-essential m4 autoconf git libncurses5-dev

ASDF-VM

FarmBot OS uses ASDF-VM to manage Erlang, Elixir, and Node versions. You can substitute your own versions assuming you have the correct versions.

# For Ubuntu or other linux distros
git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.2.1
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.bashrc
echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc
source ~/.asdf/asdf.sh

# Erlang (this one can take a while.)
asdf plugin-add erlang https://github.com/asdf-vm/asdf-erlang.git
asdf install erlang 19.1
asdf global erlang 19.1

# Elixir
asdf plugin-add elixir https://github.com/asdf-vm/asdf-elixir.git
asdf install elixir 1.3.2
asdf global elixir 1.3.2

# NodeJS
asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf install node 7.0.0
asdf global node 7.0.0

Ruby

FarmBot OS uses rvm to manage Ruby versions.

rvm use 2.3.2 --default
gem install bundler

Others

# Set up directories and what not.
cd ~/
mkdir farmbot
cd farmbot

# clone all the upstream repositories.
mkdir -p api mqtt frontend os
cd api
git init
git remote add upstream https://github.com/FarmBot/farmbot-web-api.git
git pull upstream master

cd ../mqtt
git init
git remote add upstream https://github.com/FarmBot/mqtt-gateway.git
git pull upstream master

cd ../frontend
git init
git remote add upstream https://github.com/FarmBot/farmbot-web-frontend.git
git pull upstream master

cd ../os
git init
git remote add upstream https://github.com/FarmBot/farmbot_os.git
git pull upstream master

then make sure to add your own remote to whichever repository you plan on contributing too.

git remote add origin https://github.com/MyCoolUserName/farmbot_os.git

Common ENV Variabls

export IP_ADDR=<INSERT_IP_ADDRESS_HERE>
export API_HOST=$IP_ADDR
export API_PORT=3000
export MQTT_HOST=$IP_ADDR
export RAILS_ENV=development
export OS_UPDATE_SERVER=https://api.github.com/repos/farmbot/farmbot_os/releases/latest
export FW_UPDATE_SERVER=https://api.github.com/repos/Farmbot/farmbot-arduino-firmware/releases/latest
export WEB_API_URL=http://$IP_ADDR:$API_PORT

REST API Setup

See API documentation

MQTT Setup

See MQTT documentation

OS Setup

For advanced usage see BUILDING.md

cd ~/farmbot/os
git pull upstream master
MIX_ENV=prod mix do deps.get,mix farmbot.firmware
# If you want to burn the image to an sdcard:
MIX_ENV=prod bash scripts/burn.sh

# If you want to upload the build to a RUNNING bot you can do
MIX_ENV=prod BOT_IP_ADDR=<FARMBOT_IP_ADDRESS!!!@> mix farmbot.firmware --upload

3.8 KiB Raw Blame History