IntenseWebs/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-08-26 21:27:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #300 from hmhealey/ubuntudev

Browse Source 
Updated developer setup instructions for Ubuntu
This commit is contained in:
Corey Hulen
2015-08-02 08:59:47 -08:00
parent 1ec597df59 9aebbe058e
commit f0993ff65f
1 changed files with 73 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/README_DEV.md
+73 -33
View File
@@ -1,42 +1,82 @@
Developer Machine Setup (Mac) Developer Machine Setup
----------------------------- -----------------------------
DOCKER SETUP ### Mac OS X ###
1. Follow the instructions at http://docs.docker.com/installation/mac/ 1. Download and set up Boot2Docker
1. Use the Boot2Docker command-line utility 1. Follow the instructions at http://docs.docker.com/installation/mac/
2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”` 1. Use the Boot2Docker command-line utility
2. Get your Docker IP address with `boot2docker ip` 2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` 2. Get your Docker IP address with `boot2docker ip`
4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile 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 Any issues? Please let us know on our forums at: http://forum.mattermost.org
GO SETUP ### Ubuntu ###
1. Download Go from http://golang.org/dl/ 1. Download Docker
1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below:
NODE.JS SETUP `sudo apt-get update`
`sudo apt-get install wget`
1. Install homebrew from http://brew.sh `wget -qO- https://get.docker.com/ | sh`
2. `brew install node` `sudo usermod -aG docker <username>`
`sudo service docker start`
COMPASS SETUP `newgrp docker`
2. Set up your dockerhost address
1. Make sure you have the latest version of Ruby 1. Edit your /etc/hosts file to include the following line
2. `gem install compass` `127.0.0.1 dockerhost`
3. Install build essentials
MATTERMOST SETUP 1. `apt-get install build-essential`
4. Download Go from http://golang.org/dl/
1. Make a project directory for Mattermost, which we'll call **$PROJECT** for the rest of these instructions 5. Set up your Go workspace and add Go to the PATH
2. Make a `go` directory in your $PROJECT directory 1. `mkdir ~/go`
3. Open or create your ~/.bash_profile and add the following lines: 2. Add the following to your ~/.bashrc
`export GOPATH=$PROJECT/go` `export GOPATH=$HOME/go`
`export PATH=$PATH:$GOPATH/bin` `export GOROOT=/usr/local/go`
then refresh your bash profile with `source ~/.bash_profile` `export PATH=$PATH:$GOROOT/bin`
4. Then use `cd $GOPATH` and `mkdir -p src/github.com/mattermost` then cd into this directory and run `git clone github.com/mattermost/platform.git` 3. Reload your bashrc
5. If you do not have Mercurial, download it with: `brew install mercurial` `source ~/.bashrc`
6. Then do `cd platform` and `make test`. Provided the test runs fine, you now have a complete build environment. 6. Install Node.js
7. Use `make run` to run your code 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 Any issues? Please let us know on our forums at: http://forum.mattermost.org