README.md 3.77 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
# Go (URL Shortener) [![build status](https://git.gmu.edu/srct/go/badges/master/build.svg)](https://git.gmu.edu/srct/go/commits/master)
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2

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

5
6
7
8
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
9
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
10

David Haynes's avatar
David Haynes committed
11
## Package Installation
David Haynes's avatar
David Haynes committed
12
<legend></legend>
13
### Prerequisities
David Haynes's avatar
David Haynes committed
14
First, install python and git on your system.
15
16
17
18
19
20
21
22
23
24
25
* 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:

David Haynes's avatar
David Haynes committed
26
`$ sudo apt-get install python git`
27
28
29

you install python and git.

30
31
### 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.
32

David Haynes's avatar
David Haynes committed
33
Configure your ssh keys by following the directions at [git.gmu.edu/help/ssh/README](http://git.gmu.edu/help/ssh/README).
34
35
36
37
38

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`

39
40

### Required Packages
41
Finally, install these packages from the standard repositories:
David Haynes's avatar
David Haynes committed
42
43
44
45
46
47
48
49
50
 - VirtualBox

    `$ sudo apt-get install virtualbox`
 - Vagrant

    `$ sudo apt-get install vagrant`
 - Ansible

    `$ sudo easy_install pip && sudo pip install ansible`
51
52

## Developing with Vagrant
David Haynes's avatar
David Haynes committed
53
54
55
56
57
58
59
60
61
<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.
62

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

### Additional Notes
David Haynes's avatar
David Haynes committed
66

David Haynes's avatar
David Haynes committed
67
68
69
70
71
72
73
74
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.

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:
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
75

David Haynes's avatar
David Haynes committed
76
77
78
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
79
80
81

`$ vagrant provision`

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

David Haynes's avatar
David Haynes committed
84
It is also good practice to shutdown your vm when you are done:
David Haynes's avatar
David Haynes committed
85

David Haynes's avatar
David Haynes committed
86
`$ vagrant halt`
David Haynes's avatar
David Haynes committed
87
88
89

and to restart with:

David Haynes's avatar
David Haynes committed
90
`$ vagrant up`
Jean Michel Rouly's avatar
Jean Michel Rouly committed
91

David Haynes's avatar
David Haynes committed
92
93
## On Deployment
<legend></legend>
David Haynes's avatar
David Haynes committed
94
95
96
### Deploying with Vagrant
TODO

97
98
99
100
101
102
103
### 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
104
105
106
107


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