README.md 2.28 KB
Newer Older
1
SRCTweb
Daniel W Bond's avatar
Daniel W Bond committed
2
3
===

4
Our own little site on the world wide web
Daniel W Bond's avatar
Daniel W Bond committed
5
6
7
8

On Contributing
---

Daniel W Bond's avatar
Daniel W Bond committed
9
SRCTweb welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers.
Daniel W Bond's avatar
Daniel W Bond committed
10
11
12
13
14

There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.

If you need help at all please contact and SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.

Daniel W Bond's avatar
Daniel W Bond committed
15
The project lead for this project is **Daniel Bond**. *dbond2@gmu.edu*
Daniel W Bond's avatar
Daniel W Bond committed
16
17
18
19
20
21
22
23

Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.

Setup
---

To get started, you'll need the following installed:
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)
Daniel W Bond's avatar
Daniel W Bond committed
24
25
26
* [Python 2.7.3](http://www.python.org/download/)
* [Pip](http://www.pip-installer.org/en/latest/install.html)
* [virtualenv](http://www.virtualenv.org/en/latest/index.html#installation)
Daniel W Bond's avatar
Daniel W Bond committed
27

Daniel W Bond's avatar
Daniel W Bond committed
28
29
30
Open a terminal window and type in the following commands. (If you're on Windows, use [Cygwin](http://www.cygwin.com/). This will create a local, workable copy of the project.)

(set up pip and virtualenv)
Daniel W Bond's avatar
Daniel W Bond committed
31
32

``bash``
Daniel W Bond's avatar
Daniel W Bond committed
33
34
35
36
37
``git clone git@git.gmu.edu:srct/srctweb.git``
``cd srctweb/``
``pip install -r requirements.txt``
``cd srctweb/``
``python run.py``
Daniel W Bond's avatar
Daniel W Bond committed
38
39
40
41
42

To-do
---

Note-- this should also be on the wiki
43
44

**Must Be Done Before Beta Release**
Daniel W Bond's avatar
Daniel W Bond committed
45
BETA DONE:: DROP MIC
Daniel W Bond's avatar
Daniel W Bond committed
46
only review by peers
47
48

**Also Needs to Be Done**
49
* set some stuff up, e.g. with the people page, so adding new individuals doesn't involve touching the template
50
* Figure out parallaxjs (use jquery) for front page
51
* Figure out intellectual property with GMU
52
* add piwik opt out link
53
* finish writing privacy policy
Daniel W Bond's avatar
typos    
Daniel W Bond committed
54
* affix js for documents navigation-- example http://www.bootstrapzero.com/bootstrap-template/affix-sidebar
Daniel W Bond's avatar
Daniel W Bond committed
55

Daniel W Bond's avatar
Daniel W Bond committed
56
57
58
---

**S**tudent - **R**un **C**omputing and **T**echnology (*SRCT*, pronounced "circuit") is a student organization at George Mason University which enhances student computing at Mason. SRCT establishes and maintains systems which provide specific services for Mason's community.