Groot

Groot is the next generation web application serving the UIUC Chapter of ACM. It is the replacement for liquid which goes defunct 1/1/2016.

Groot Projects

• groot - Infrastructure of ACM@UIUC

Javascript

• groot-desktop-frontend - Desktop Frontend for Groot
• groot-events-service - Manages ACM events
• groot-groups-service - Manages ACM groups

Python

• groot-credits-service - Unified payment system for ACM@UIUC
• groot-gigs-service - Supporting the Groot economy
• groot-meme-service - Internal ACM@UIUC Meme Board
• groot-voz - Alexa integrations for Groot

Ruby

• groot-auth-stub-service - A development authentication service that mocks crowd and returns a fake user
• groot-merch-service - Groot service for injecting caffeine into your blood stream
• groot-quotes-service - Manages quotes heard around the ACM office
• groot-recruiters-service - Recruiter Services for Groot
• groot-recruiters-templates-example - Holds template used by the Recruiter service to send emails
• groot-users-service - Users Services for Groot

Go

• groot-api-gateway - API Gateway for the Groot project written in Arbor

Setting Up Groot

1. Follow these instructions to install Docker and docker-compose.

2. Install repo - https://android.googlesource.com/tools/repo/

   Mac OS

   brew install repo 

   Ubuntu 14.04+

   sudo apt install repo
   

3. Make a directory to house your groot work

   mkdir groot-deploy

4. Within this directory run the following command to start managing the projects

   repo init -u git@github.com:acm-uiuc/groot-manifest

5. Run the following command to grab the latest releases of all services, including the frontend

   repo sync

6. Run the settings init script:

   ./scripts/docker_settings_init.sh

7. Start up Docker. (This may involve docker-machine if you're on a Mac)

8. Start the Docker containers:

   docker-compose up

9. Wait for the image to build and startup. If it works, you'll be able to visit https://0.0.0.0:5000 in a browser and see the deployed site. The Groot API will be available on port 8000.

   a. If you see errors it is most likely because you need to create configuration files for each of the services. For each service with an error, copy and rename the template file to the name of the file minus template. For example groot-api-gateway/config/config.go.template should be copied and renamed to groot-api-gateway/config/config.go

Useful Notes:

• If you want to just rebuild one service (i.e. for dev work), you can keep the docker-compose command running, and run this command in a separate terminal window to rebuild the service you're working on:

  docker-compose up -d --build SERVICE
  

• For dev work you'll probably want to run in unauthenticated mode. To do this, change the CMD line in groot-api-gateway/Dockerfile to:

  CMD ["./build/groot-api-gateway", "-u"]
  

• To view logs, run:

  sudo docker-compose logs -f
  

Legacy Instructions

Note: It is necessary for you to have an ssh key (without a password if you want it to be even easier) attached to your github

1. Install repo - https://android.googlesource.com/tools/repo/

   Mac OS

   brew install repo 

   Ubuntu 14.04+

   sudo apt install repo
   

2. Make a directory to house your groot work

   mkdir groot

3. Within this directory run the following command to start managing the projects

   repo init -u git@github.com:acm-uiuc/groot-manifest

4. Run the following command to grab the latest releases of the services and frontend

   repo sync

   • If you want to grab the latest ever just run the same command

5. Run the dev_spinup.sh script to start up a dev instance of groot (will grab the latest version of each service on github)

6. Run the prod_spinup.sh script to start a production version of groot (will grab the latest version of each and place them in their respective containers, so you will need docker)

First Time Setup

• Golang

  • Install Software

  mkdir [SOME DIRECTORY]
  mkdir [SOME DIRECTORY]/bin && mkdir [SOME DIRECTORY]/lib \
  && mkdir [SOME DIRECTORY]/src
  mkdir -p [SOME DIRECTORY]/src/github.com/acm-uiuc

  --- Add to .profile (.zshrc/.bashrc) ---

  export GOPATH=[SOME DIRECTORY]
  
  #macOS 
  export GOROOT=/usr/local/opt/go/libexec
  #Ubuntu 14.04+
  export GOROOT=/usr/local/go
  
  export PATH=$PATH:$GOPATH/bin
  export PATH=$PATH:$GOROOT/bin

  #macOS
  brew install go
  #Ubuntu 14.04+
  sudo curl -O https://storage.googleapis.com/golang/go1.7.linux-amd64.tar.gz
  sudo tar -xvf go1.7.linux-amd64.tar.gz
  sudo mv go /usr/local

  • Add groot to GOPATH

  ln -s [PATH to groot-deploy]/groot-api-gateway [SOME DIRECTORY]/src/github.com/acm-uiuc/groot-api-gateway

  • Install groot dependecies

  go get github.com/gorilla/mux
  
  go get github.com/boltdb/bolt
  
  go get github.com/kennygrant/sanitize
  
  go get github.com/acm-uiuc/arbor/server
  
  go get github.com/acm-uiuc/arbor/services
  
  go get github.com/acm-uiuc/arbor/security
  
  go get github.com/acm-uiuc/arbor/proxy
  
  go install github.com/gorilla/mux
  
  go install github.com/boltdb/bolt
  
  go install github.com/kennygrant/sanitize
  
  go install github.com/acm-uiuc/arbor/server
  
  go install github.com/acm-uiuc/arbor/services
  
  go install github.com/acm-uiuc/arbor/security
  
  go install github.com/acm-uiuc/arbor/proxy

  • Install packages

  go install github.com/acm-uiuc/groot-api-gateway/config
  
  go install github.com/acm-uiuc/groot-api-gateway/services

• Node

  • Install Software

  #macOS
  brew install node
  #Ubuntu 14.04+  
  sudo apt-get install nodejs
  sudo apt-get install npm
  sudo apt-get install build-essential
  sudo apt-get update
  sudo apt-get install build-essential libssl-dev
  curl -sL https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh -o install_nvm.sh
  bash install_nvm.sh
  source ~/.profile
  nvm install 7.2.0
  nvm use 7.2.0
  sudo npm install -g forever

• Ruby

  • Install Software

  #macOS
  brew install rbenv
  #Ubuntu 14.04+
  sudo apt-get install autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm3 libgdbm-dev
  git clone https://github.com/rbenv/rbenv.git ~/.rbenv
  echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc (~/.profile / ~/.zshrc)
  echo 'eval "$(rbenv init -)"' >> ~/.bashrc (~/.profile / ~/.zshrc)
  source ~/.bashrc (~/.profile / ~/.zshrc)
  git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
  
  rbenv install 2.3.1
  rbenv global 2.3.1
  # You may have to restart your terminal session
  gem install bundler

• Python

  • Install Software

  #macOS 
  brew install python 
  #Ubuntu
  sudo apt install python-pip
  

• MySQL

  • Install Software

  #macOS
  brew install mysql
  mysqladmin -u root password 'yourpassword' 
  mysql.server restart
  #Ubuntu 14.04+
  sudo apt-get install mysql-server
  sudo apt-get install libmysqlclient-dev
  sudo mysqld --intialize
  
  mysql -u root
  mysql> CREATE DATABASE groot_recruiter_service;
  mysql> CREATE DATABASE acm_users;
  mysql> CREATE DATABASE groot_meme_service;
  mysql> CREATE DATABASE groot_quotes_service;

License

This project is licensed under the University of Illinois/NCSA Open Source License. For a full copy of this license take a look at the LICENSE file.

When contributing new files to this project, preappend the following header to the file as a comment:

Copyright © 2017, ACM@UIUC

This file is part of the Groot Project.  
 
The Groot Project is open source software, released under the University of Illinois/NCSA Open Source License. 
You should have received a copy of this license in a file with the distribution.