README.md 879 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
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.

Daniel W Bond's avatar
Daniel W Bond committed
9 10 11
## To D0
* qr codes on links view-- need to save the pictures somewhere, render inline as well as in different formats and sizes for download, and be deleted along with the links

12 13
## Configuration

Jean Michel Rouly's avatar
Jean Michel Rouly committed
14
### settings.py
Jean Michel Rouly's avatar
Jean Michel Rouly committed
15

Jean Michel Rouly's avatar
Jean Michel Rouly committed
16 17
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
18

Jean Michel Rouly's avatar
Jean Michel Rouly committed
19
### nginx / Apache
20

Jean Michel Rouly's avatar
Jean Michel Rouly committed
21 22
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
23

Jean Michel Rouly's avatar
Jean Michel Rouly committed
24
### Python
25

Jean Michel Rouly's avatar
Jean Michel Rouly committed
26
To install the required Python modules, simply execute
27 28

```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
29
$ pip install -r requirements.txt
30
```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
31 32

and you should be good to go.