README.md 1.71 KB
Newer Older
1
# Go (URL Shortener)
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2 3 4

A project of [GMU SRCT](http://srct.gmu.edu).

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
## Package Installation
10 11
<legend>
### Prerequisities
12 13 14 15 16 17 18 19 20 21 22 23
First, install python, pip, and git on your system.
* 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
24
`$ sudo apt-get install python git`
25 26 27

you install python and git.

28 29
### 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.
30

31
Configure your ssh keys by following the directions at [git.gmu.edu/help/ssh/README](git.gmu.edu/help/ssh/README).
32 33 34 35 36

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`

37 38

### Required Packages
39
Finally, install these packages from the standard repositories:
40 41 42 43 44 45 46
 - VirtualBox ??
 - Vagrant ++
 - Ansible ++

## Developing with Vagrant
<legend>
### Initial Setup
47

Jean Michel Rouly's avatar
Jean Michel Rouly committed
48

David Haynes's avatar
David Haynes committed
49
## On Deployemnt
50
<legend>
51 52 53 54 55 56 57
### 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.