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

Daniel W Bond's avatar
Daniel W Bond committed
9
## To D0
10 11 12 13 14 15 16 17 18 19 20 21
* 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
* Update the user authentication system (ie. port it to CAS to play nicely
    with GMU)
* Update the user registration system. Make it more intuitive to first time
    users, also update the connection between registered users and actual
    user auth accounts on the database.
* Set up Piwik to work with Go.
* Update the documentation on Go to include a setup guide
* Update the interface to bootswatch, perhaps? Maybe the same stylesheet as
    is used on SRCTWeb. (ie. complete HTML overhaul)
Daniel W Bond's avatar
Daniel W Bond committed
22

23 24
## Configuration

Jean Michel Rouly's avatar
Jean Michel Rouly committed
25
### settings.py
Jean Michel Rouly's avatar
Jean Michel Rouly committed
26

Jean Michel Rouly's avatar
Jean Michel Rouly committed
27 28
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
29

Jean Michel Rouly's avatar
Jean Michel Rouly committed
30
### nginx / Apache
31

Jean Michel Rouly's avatar
Jean Michel Rouly committed
32 33
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
34

Jean Michel Rouly's avatar
Jean Michel Rouly committed
35
### Python
36

Jean Michel Rouly's avatar
Jean Michel Rouly committed
37
To install the required Python modules, simply execute
38 39

```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
40
$ pip install -r requirements.txt
41
```
Jean Michel Rouly's avatar
Jean Michel Rouly committed
42 43

and you should be good to go.