README.md 699 Bytes
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 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.

## Configuration

Jean Michel Rouly's avatar
Jean Michel Rouly committed
11
### settings.py
Jean Michel Rouly's avatar
Jean Michel Rouly committed
12

Jean Michel Rouly's avatar
Jean Michel Rouly committed
13 14
The settings file should already be configured acceptably. You may need to
add a different authentication backend or database engine.
Jean Michel Rouly's avatar
Jean Michel Rouly committed
15

Jean Michel Rouly's avatar
Jean Michel Rouly committed
16
### nginx / Apache
17

Jean Michel Rouly's avatar
Jean Michel Rouly committed
18 19
You must configure an outside web server to properly host the static file
required to run this Django app.
Jean Michel Rouly's avatar
Jean Michel Rouly committed
20

Jean Michel Rouly's avatar
Jean Michel Rouly committed
21
### Python
22

Jean Michel Rouly's avatar
Jean Michel Rouly committed
23
To install the required Python modules, simply execute
24 25

```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
26
$ pip install -r requirements.txt
27
```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
28 29

and you should be good to go.