README.md 5.91 KB
Newer Older
1 2 3
# Go (URL Shortener) [![build status](https://git.gmu.edu/srct/go/badges/master/build.svg)](https://git.gmu.edu/srct/go/commits/master) [![coverage report](https://git.gmu.edu/srct/go/badges/master/coverage.svg)](https://git.gmu.edu/srct/go/commits/master)


Jean Michel Rouly's avatar
Jean Michel Rouly committed
4

David Haynes's avatar
David Haynes committed
5
A project of [GMU SRCT](http://srct.gmu.edu).
Jean Michel Rouly's avatar
Jean Michel Rouly committed
6

7 8 9 10
Go is a drop-in URL shortening service. It aims to provide an easily
branded service for institutions that wish to widely disseminate
information without unnecessarily outsourcing branding.

David Haynes's avatar
David Haynes committed
11
I encourage you to join the #go channel in SRCT's [Slack Group](http://srct.slack.com) if you have any questions on setup or would like to contribute.
David Haynes's avatar
David Haynes committed
12

David Haynes's avatar
David Haynes committed
13
## Package Installation
David Haynes's avatar
David Haynes committed
14
<legend></legend>
15

16
### Prerequisities
David Haynes's avatar
David Haynes committed
17
First, install python and git on your system.
18 19 20 21 22 23 24 25 26 27 28
* Python is the programming language used for Django, the web framework used by Go.
* Git is the version control system used for SRCT projects.

Open a terminal and run the following command:

`$ sudo apt-get update`

This retrieves links to the most up-to-date and secure versions of your packages.

Next, with:

29
`$ sudo apt-get install python python-dev python-pip git`
30 31 32

you install python and git.

33
**macOS (Formerly OS X)**
Zosman's avatar
Zosman committed
34

35
This tutorial uses the third party Homebrew package manager for macOS, which allows you to install packages from your terminal just as easily as you could on a Linux based system. You could use another package manager (or not use one at all), but Homebrew is highly reccomended.
Zosman's avatar
Zosman committed
36

37
To get homebrew, run the following command in a terminal: `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)`
Zosman's avatar
Zosman committed
38

39
**Note**: You do NOT need to use `sudo` when running any Homebrew commands, and it likely won't work if you do.
Zosman's avatar
Zosman committed
40

41
Next, to make sure Homebrew is up to date, run `brew update`
Zosman's avatar
Zosman committed
42

43
Finally we can install python and git with `brew install python git`
Zosman's avatar
Zosman committed
44

45 46
### Cloning the Go Codebase
Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](http://git.gmu.edu/srct/go), the SRCT code respository.
47

David Haynes's avatar
David Haynes committed
48
Configure your ssh keys by following the directions at [git.gmu.edu/help/ssh/README](http://git.gmu.edu/help/ssh/README).
49 50 51 52 53

Now, on your computer, navigate to the directory in which you want to download the project (perhaps one called development/ or something similar), and run

`$ git clone git@git.gmu.edu:srct/go.git`

54
### If Using Docker
55
First, install Docker on your system.
56 57 58
* For macOS go here: https://docs.docker.com/docker-for-mac/
* For windows go here: https://docs.docker.com/docker-for-windows/
* For you specific linux disro go here: https://docs.docker.com/engine/installation/
59

60 61 62
Additionally if you are not on Mac or Windows you will need to install docker-compose: https://docs.docker.com/compose/install/

Next go to the directory with the docker-compose file in it and run:
mdsecurity's avatar
mdsecurity committed
63 64 65

`$ docker-compose up`

Robert Hitt's avatar
Robert Hitt committed
66 67 68 69
If that doesn't work, try:

`$ sudo docker-compose up`

70
SOMETIMES if this branch is updated you might have to 
mdsecurity's avatar
mdsecurity committed
71 72
You should see that the server is running by going to http://localhost:8000 in your browser.
Any changes you make to your local file system will be mirrored in the server.
73

74
### If Using Vagrant
75
Finally, install these packages from the standard repositories:
David Haynes's avatar
David Haynes committed
76 77
 - VirtualBox

78
    On Ubuntu:
David Haynes's avatar
David Haynes committed
79
    `$ sudo apt-get install virtualbox`
80

Zosman's avatar
Zosman committed
81

82
    You should be installing the latest VirtualBox version which as of time of writing is `5.0.24_Ubuntur108355`. You can verify the version number by running `vboxmanage --version`.
83

David Haynes's avatar
David Haynes committed
84 85 86
 - Vagrant

    `$ sudo apt-get install vagrant`
87 88

    You should be installing the latest vagrant version which as of time of writing is `Vagrant 1.8.1`. You can verify the version number by running `vagrant -v`.
David Haynes's avatar
David Haynes committed
89 90
 - Ansible

91 92 93
    `$ sudo pip install ansible`

    You should be installing the latest ansible version which as of time of writing is `ansible 2.1.1.0`. You can verify the version number by running `ansible --version`.
Zosman's avatar
Zosman committed
94

95
  **macOS**
Zosman's avatar
Zosman committed
96

97
  First, get VirtualBox from [VirtualBox.org](https://www.virtualbox.org/wiki/Downloads)
Zosman's avatar
Zosman committed
98

99
  Then install Vagrant and Ansible with Homebrew with `brew install Caskroom/cask/vagrant Ansible`
100 101

## Developing with Vagrant
David Haynes's avatar
David Haynes committed
102 103 104 105 106 107 108 109 110
<legend></legend>
Vagrant allows for the virtualization of your development enviornment and automates the setup process for Go.

### Vagrant Setup
Navigate to go/ and run:

`$ vagrant up`

This will setup a vm to run Go on your computer and will setup a database, install packages, etc. The first time you run `vagrant up` it may take a few minutes to setup, specifically when installing Go packages. Don't worry as progressive times it will speed up.
111

Zosman's avatar
Zosman committed
112
And that's it! Navigate to [localhost:8000](http://127.0.0.1:8000) in your web browser to view the website.
David Haynes's avatar
David Haynes committed
113

114
### Additional Notes & Troubleshooting
David Haynes's avatar
David Haynes committed
115

David Haynes's avatar
David Haynes committed
116 117 118 119
The authentication service used for Go is CAS. In local development however we utilize a test server. You can log in using your CAS username for both the username and password fields.

 The default superuser is _dhaynes3_ though this can be changed in _vagrantfile_ if you wish. You can run `$ vagrant provision` to apply this change. Be sure not to include that change in your commits.

120
*Note:* For a currently undetermined reason at some points if you try to navigate to [localhost](http://127.0.0.1:8000) and you see an error like: "Conenction has been reset" then:
David Haynes's avatar
David Haynes committed
121 122 123
1. `vagrant ssh`
2. `sudo /etc/init.d/networking restart` and then `exit`
3. `vagrant provision` (may need to do twice)
David Haynes's avatar
David Haynes committed
124

David Haynes's avatar
David Haynes committed
125 126 127
This is the only temporary fix that we know exists.

If you make any changes to _models.py_ you will need to re-provision the vm's database:
David Haynes's avatar
David Haynes committed
128 129 130

`$ vagrant provision`

David Haynes's avatar
David Haynes committed
131
Please note that this will refresh the database (as in delete everything in it).
David Haynes's avatar
David Haynes committed
132 133


134 135 136 137 138 139 140
### Cron

In order to expire links, you need to set up a cron job to run the manage.py
expirelinks command regularly. A sample cron script is available in the
repository and is named go-cleanlinks.cron. Drop this in cron.hourly and
change the paths so that they point to the virtualenv activate script and
manage.py.
David Haynes's avatar
David Haynes committed
141 142 143


### Note
144
Link by Viktor Vorobyev from the Noun Project.