README.md 9.45 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
# Go
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2

David Haynes's avatar
David Haynes committed
3
[![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) [![python version](https://img.shields.io/badge/python-2.7,3.4+-blue.svg)]() [![Django version](https://img.shields.io/badge/Django-1.11-brightgreen.svg)]() [![SemVer version](https://img.shields.io/badge/SemVer Version-2.2.3-yellowgreen.svg)]()
Jean Michel Rouly's avatar
Jean Michel Rouly committed
4

5
#### A project of [GMU SRCT](https://srct.gmu.edu).
6

David Haynes's avatar
David Haynes committed
7 8 9
Go is a drop-in URL shortening service. This project aims to provide an easy to use
URL branding service for institutions that wish to widely disseminate information
without unnecessarily outsourcing branding.
10

David Haynes's avatar
David Haynes committed
11 12
Go is currently a `Python 3` (with backwards compatability foor `Python 2.7` until
Django 2.0 in December 2017) project written in the `Django` web framework, with
David Haynes's avatar
David Haynes committed
13
`MySQL` as our backend database.
14

David Haynes's avatar
David Haynes committed
15
# Setup instructions for local development
16

David Haynes's avatar
David Haynes committed
17 18 19 20
Go currently supports developers on Linux, macOS and Windows platforms through
both the Docker and Vagrant virtualization platforms. You may use either one
though we have included instructions for manual setup as well. Here's our walk-through
of steps we will take:
21

David Haynes's avatar
David Haynes committed
22 23 24
1. Install `git` on your system.
2. Clone the Go codebase.
3. Get Go up and running with the method of your choice.
Zosman's avatar
Zosman committed
25

David Haynes's avatar
David Haynes committed
26
## 1) Install `git` on your system.
Zosman's avatar
Zosman committed
27

David Haynes's avatar
David Haynes committed
28
`git` is the version control system used for SRCT projects.
Zosman's avatar
Zosman committed
29

David Haynes's avatar
David Haynes committed
30
### On Linux Based Systems
Zosman's avatar
Zosman committed
31

David Haynes's avatar
David Haynes committed
32 33
**with apt:**

David Haynes's avatar
David Haynes committed
34
Open a terminal and run the following command:
mdsecurity's avatar
mdsecurity committed
35

David Haynes's avatar
David Haynes committed
36
    sudo apt update
Robert Hitt's avatar
Robert Hitt committed
37

David Haynes's avatar
David Haynes committed
38
This retrieves links to the most up-to-date and secure versions of your packages.
Robert Hitt's avatar
Robert Hitt committed
39

David Haynes's avatar
David Haynes committed
40
Next, with:
41

David Haynes's avatar
David Haynes committed
42
    sudo apt install git
43

David Haynes's avatar
David Haynes committed
44
you install `git` onto your system.
45

David Haynes's avatar
David Haynes committed
46
### On macOS
Zosman's avatar
Zosman committed
47

David Haynes's avatar
David Haynes committed
48 49 50 51
We recommend that you use 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.
52

David Haynes's avatar
David Haynes committed
53
To get homebrew, run the following command in a terminal:
54

David Haynes's avatar
David Haynes committed
55
    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
56

David Haynes's avatar
David Haynes committed
57 58
**Note**: You do NOT need to use `sudo` when running any Homebrew commands, and
it likely won't work if you do.
59

David Haynes's avatar
David Haynes committed
60
Next, to make sure Homebrew is up to date, run:
61

David Haynes's avatar
David Haynes committed
62
    brew update
Zosman's avatar
Zosman committed
63

David Haynes's avatar
David Haynes committed
64 65 66
Finally we can install git with:

    brew install git
Zosman's avatar
Zosman committed
67

David Haynes's avatar
David Haynes committed
68
### On Windows
David Haynes's avatar
David Haynes committed
69

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
We recommend that if you are on Windows 10 AE (Anniversary Edition) or above to make use of the
Windows Subsystem for Linux (WSL). The following link should get you up and running: 

[https://msdn.microsoft.com/en-us/commandline/wsl/install_guide](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)


#### Contributing with Windows

After that is setup, you should be able to follow the Linux instructions for _manual setup_ to
contribute to the project. 

If you are not on Windows 10 or would rather prefer to not use the WSL you may download Git for
Windows here:

[https://git-scm.com/download/win](https://git-scm.com/download/win)

You'll want to follow the Vagrant setup method as it is designed to run on all platforms 
including Windows. 

I have also successfully ran the project with Docker, though you need
access to Hyper-V which is only available on "Professional" versions of Windows. 
Zosman's avatar
Zosman committed
91

David Haynes's avatar
David Haynes committed
92
## 2) Clone the Go codebase.
David Haynes's avatar
David Haynes committed
93

94
Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](https://git.gmu.edu/srct/go),
David Haynes's avatar
David Haynes committed
95 96 97
the SRCT code respository with SSH.

**a)** Configure your ssh keys by following the directions at:
98

99
[git.gmu.edu/help/ssh/README](https://git.gmu.edu/help/ssh/README).
100

David Haynes's avatar
David Haynes committed
101
**b)** Now, on your computer, navigate to the directory in which you want to download the project (ie. perhaps one called `development/SRCT`), and run
102

David Haynes's avatar
David Haynes committed
103
    git clone git@git.gmu.edu:srct/go.git
104

David Haynes's avatar
David Haynes committed
105
## 3) Get Go up and running with the method of your choice.
106

David Haynes's avatar
David Haynes committed
107 108 109 110 111 112
Now that we have `git` setup and cloned down the code you can

    cd go/

and get to working on setting up a development environment!

David Haynes's avatar
David Haynes committed
113
### Docker
114

David Haynes's avatar
David Haynes committed
115 116 117 118 119 120 121
Docker is an emerging containerization platform written in Google's Go
language.
Instead of running a full VM that runs Go, we package up all the
various bits that make up Go and run that as a container (two
containers: one for Go and the other for mysql) that act as normal
processes to the OS.   

David Haynes's avatar
David Haynes committed
122 123
Check out [docker.com](https://www.docker.com/what-docker) for more details.

David Haynes's avatar
David Haynes committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
Pros:

 - Lightweight
    - Can be run on most machines without needing significant resources.
    - SRCT members report minimal battery impact on laptops.
 - Fast
    - Compared to other methods, Docker is comparatively faster than
    Vagrant or manual setup.
 - Minimal setup
    - You run one command. Really easy to get up and running once you install
    Docker.
 - Good cross platform support
    - Runs smoothly on macOS, Linux, and Windows
    - Great docs to help if you get stuck.
 - Can easily destroy and rebuild the docker images
 - Loads in changes to code on the fly

Cons:
142

David Haynes's avatar
David Haynes committed
143 144 145
 - Challenging to debug problems
    - Cannot interact with attached images and as a result, you cannot really
    interact with the database.
146

David Haynes's avatar
David Haynes committed
147
There are instructions on how to setup/develop with Docker at the [docker-configuration page in the Go project wiki](https://git.gmu.edu/srct/go/wikis/docker-configuration).
148

David Haynes's avatar
David Haynes committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
### Vagrant + Ansible

Vagrant boots up a full virtual machine (VM) through VirtualBox that then runs Go. A
script written with Ansible will then run on that VM to automate the setup process
for you. It is similar in a way to running Go on a legitimate server.

Pros:

  - Very similar to a production environment
  - Can use `vagrant ssh` to "ssh" into the VM to debug things such as the
    database.
  - Relatively straightforward and easy setup.
    - One Command.
  - Can easily destroy and rebuild the VM.
  - Loads in changes to code on the fly.
  - Fast-ish (Initial provision takes a bit).

Cons:

  - Heavier on resources.
    - It's literally a full VM.
  - Occasional issues/hiccups.
    - Documented fixes are in the wiki.

There are instructions on how to setup with Vagrant at the [vagrant-configuration
page in the Go project wiki](https://git.gmu.edu/srct/go/wikis/vagrant-configuration).

Additionally, there is documentation about developing with Vagrant at
the [vagrant-usage page in the Go project wiki](https://git.gmu.edu/srct/go/wikis/vagrant-usage).
178

David Haynes's avatar
David Haynes committed
179
### Manual Setup
180

David Haynes's avatar
David Haynes committed
181 182 183 184 185 186 187 188 189 190 191
Manual setup (or: the old fashioned way) is where you install all dependecies on
your system and run Go as a local server with Django. Granted you are technically
doing that with Vagrant and Docker except those platforms automate the steps that
are laid out in this section.

Pros:
  - Experience setting up a Django project for local development

Cons:
  - Greater potential for things to go wrong
  - Way more steps
192

David Haynes's avatar
David Haynes committed
193 194 195 196
Head to:

https://git.gmu.edu/srct/go/wikis/manual-setup

David Haynes's avatar
David Haynes committed
197 198 199

# Some words about contributing to Go.

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
## Testing

You are _very strongly_ encouraged to write test cases where applicible for
code that you contribute to the repo. This is not a rule at the moment but rather
a strong suggestion. It's good practice for corporate land and will also ensure
your code works. Additionally, there are quite a few example ones to look at in
the repo and on Google.

### Running Unit Tests

Unit tests are run on every commit sent to gitlab though that can be a pain to
rely on. Here's how to run them locally:

#### Docker

Docker is not supported currently for running unit tests. If you're able to get
it set up, open a merge request and I'll merge it in.

#### Vagrant

    vagrant up
    vagrant ssh
    cd /vagrant
    source venv/bin/activate
    cd go
225
    source sourceme.sh
226 227 228 229 230 231 232 233
    python manage.py test

#### Manual Setup

Assuming you are within your virtualenv:

    python manage.py test

234
## CONTRIBUTING.md
235

236 237 238 239 240 241 242 243 244
This document goes into detail about how to contribute to the repo, plus some
opinions about using `git`.

## Opening issues

There is a template for issue descriptions located on the new issue page. I will
close issues with poor descriptions or who do not follow the standard.

## Authentication
David Haynes's avatar
David Haynes committed
245 246 247 248 249

The authentication service used for Go is CAS. In local development however we
utilize a test server. You can log in with just your CAS username to simulate logging
in. By default, the Django superuser is set to `dhaynes3`.

250 251 252 253 254
In order to approve yourself to be an 'approved user' you must navigate to 127.0.0.1:8000/admin and log in.
Once in the admin page go to "registered users", and create a new registered user in the top right. Be sure to
use the same username and Full Name as your main account and select "approved" in the bottom row.

## Coding style
255

256 257 258 259 260
You should adhere to the style of the repo code. Consistancy is key! PEP8 guidelines
are strongly reccomended but not enforced at the time. Please comment your code,
I will not accept commits that contain uncommented code.

## Getting Help
David Haynes's avatar
David Haynes committed
261

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

David Haynes's avatar
David Haynes committed
265 266
# Some words about deploying Go.

267 268 269
Check out our admin guide:

https://git.gmu.edu/srct/go/wikis/administration-guide
270 271 272 273 274 275

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.
276

David Haynes's avatar
David Haynes committed
277 278
---
**Note:**
279

280
Link by Viktor Vorobyev from the Noun Project.