diff options
author | it33 <iantien@gmail.com> | 2015-09-02 21:37:01 -0700 |
---|---|---|
committer | it33 <iantien@gmail.com> | 2015-09-02 21:37:01 -0700 |
commit | 925edea6f0452a55d7345e8dc5dee79a687cc568 (patch) | |
tree | 8788eafb1e2732a32f97be77d0835757807455f1 /doc | |
parent | 3d51de60cf0b6d45af111c5862d877c5a9d0d725 (diff) | |
parent | def20f7e3238f69cf84ac8e2d6527d13de294648 (diff) | |
download | chat-925edea6f0452a55d7345e8dc5dee79a687cc568.tar.gz chat-925edea6f0452a55d7345e8dc5dee79a687cc568.tar.bz2 chat-925edea6f0452a55d7345e8dc5dee79a687cc568.zip |
Merge pull request #573 from mattermost/it33-patch-10
Rename scripts/README_DEV.md to doc/install/dev-setup.md
Diffstat (limited to 'doc')
-rw-r--r-- | doc/install/dev-setup.md | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/install/dev-setup.md b/doc/install/dev-setup.md new file mode 100644 index 000000000..a088bbbc2 --- /dev/null +++ b/doc/install/dev-setup.md @@ -0,0 +1,82 @@ +Developer Machine Setup +----------------------------- + +### Mac OS X ### + +1. Download and set up Boot2Docker + 1. Follow the instructions at http://docs.docker.com/installation/mac/ + 1. Use the Boot2Docker command-line utility + 2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”` + 2. Get your Docker IP address with `boot2docker ip` + 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` + 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile +2. Download Go from http://golang.org/dl/ +3. Set up your Go workspace + 1. `mkdir ~/go` + 2. Add the following to your ~/.bash_profile + `export GOPATH=$HOME/go` + `export PATH=$PATH:$GOPATH/bin` + 3. Reload your bash profile + `source ~/.bash_profile` +4. Install Node.js using Homebrew + 1. Download Homebrew from http://brew.sh/ + 2. `brew install node` +5. Install Compass + 1. Make sure you have the latest verison of Ruby + 2. `gem install compass` +6. Download Mattermost + `cd ~/go` + `mkdir -p src/github.com/mattermost` + `cd src/github.com/mattermost` + `git clone github.com/mattermost/platform.git` + `cd platform` +7. Run unit tests on Mattermost using `make test` to make sure the installation was successful +8. If tests passed, you can now run Mattermost using `make run` + +Any issues? Please let us know on our forums at: http://forum.mattermost.org + +### Ubuntu ### + +1. Download Docker + 1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below: + `sudo apt-get update` + `sudo apt-get install wget` + `wget -qO- https://get.docker.com/ | sh` + `sudo usermod -aG docker <username>` + `sudo service docker start` + `newgrp docker` +2. Set up your dockerhost address + 1. Edit your /etc/hosts file to include the following line + `127.0.0.1 dockerhost` +3. Install build essentials + 1. `apt-get install build-essential` +4. Download Go from http://golang.org/dl/ +5. Set up your Go workspace and add Go to the PATH + 1. `mkdir ~/go` + 2. Add the following to your ~/.bashrc + `export GOPATH=$HOME/go` + `export GOROOT=/usr/local/go` + `export PATH=$PATH:$GOROOT/bin` + 3. Reload your bashrc + `source ~/.bashrc` +6. Install Node.js + 1. Download the newest version of the Node.js sources from https://nodejs.org/download/ + 2. Extract the contents of the package and cd into the extracted files + 3. Compile and install Node.js + `./configure` + `make` + `make install` +7. Install Ruby and Compass + `apt-get install ruby` + `apt-get install ruby-dev` + `gem install compass` +8. Download Mattermost + `cd ~/go` + `mkdir -p src/github.com/mattermost` + `cd src/github.com/mattermost` + `git clone github.com/mattermost/platform.git` + `cd platform` +9. Run unit tests on Mattermost using `make test` to make sure the installation was successful +10. If tests passed, you can now run Mattermost using `make run` + +Any issues? Please let us know on our forums at: http://forum.mattermost.org |