Skip to content

Latest commit

 

History

History
142 lines (99 loc) · 4.04 KB

DEVELOPER.md

File metadata and controls

142 lines (99 loc) · 4.04 KB
Raw

Development Environment Setup

This document contains general guidelines for setting up a development environment sufficient for getting started with contributing to this project:

See the contribution guidelines to start contributing.

Mac OS Setup

1. Install Homebrew

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

For more details, go to Homebrew.

2. Install Git Duet

$ brew tap git-duet/tap
$ brew install git-duet

3. Install Yarn

$ brew install yarn --without-node

4. Install Nvm

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash
$ nvm install

If you are on a Mac and having trouble, make sure to run touch ~/.bash_profile before running the above command.

5. Install Direnv

$ brew install direnv
$ echo 'eval "$(direnv hook bash)"' >> ~/.bashrc

Note: In order for the above to work on MacOS, your .bash_profile needs to be setup to read your .bashrc by containing the following:

# Either this
[[ -r ~/.bashrc ]] && . ~/.bashrc

# Or this
if [ -f $HOME/.bashrc ]; then
  source $HOME/.bashrc
fi

You can check your .bash_profile with:

$ open ~/.bash_profile

# If it doesn't contain either of the above
$ echo '[[ -r ~/.bashrc ]] && . ~/.bashrc' >> ~/.bash_profile

After doing this, anything in your .bash_profile other than the configuration above can now be moved to your .bashrc

6. Restart the terminal and then run the following

$ cd ~/workspace/calltocode.org
$ nvm install
$ direnv allow

7. Install Docker

8. Make sure your IDE supports editorconfig

9. (Optional) Download Robo 3T

Robo 3T (formerly known as Robomongo) is a MongoDB management tool with a GUI, making it easy to view and manage the database.

Linux Setup

1. Install Linuxbrew

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install)"

2. Add Linuxbrew to your PATH

2.1. Debian/Ubuntu

$ test -d ~/.linuxbrew && PATH="$HOME/.linuxbrew/bin:$PATH"
$ test -d /home/linuxbrew/.linuxbrew && PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"
$ test -r ~/.profile && echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.profile
$ echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.profile

2.2. CentOS/Fedora/RedHat

$ test -d ~/.linuxbrew && PATH="$HOME/.linuxbrew/bin:$PATH"
$ test -d /home/linuxbrew/.linuxbrew && PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"
$ test -r ~/.bash_profile && echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.bash_profile
$ echo 'export PATH="$(brew --prefix)/bin:$PATH"' >>~/.bash_profile

For more details, go to Linuxbrew.

3. Follow Mac OS Setup starting from section 2

Windows 10 Setup

It is recommended that you use a mac or linux, but if you only have a pc, follow these steps to setup ubuntu bash.

Shell Setup

  1. Update your Windows 10 to the latest build.
  2. Run powershell as administrator and execute the following.
$ Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux`
  1. Enable Developer Mode in Windows settings.
  2. Run command prompt as administrator and execute the following.
$ bash
  1. After setup, open "Bash on Ubuntu on Windows". Add this to your dock.
  2. Click the Ubuntu icon on the top left of the window, and click Defaults.
  3. Setup Font -> Size 14, Font Lucida Console.
  4. Enable QuickEdit Mode.
  5. Restart bash.