Commit 485fd03d authored by David Haynes's avatar David Haynes

Additional README explaining

- superuser
- http:// added where needed
- the connection reset bug "fix" yay :dhaynes:
parent 21633793
...@@ -6,12 +6,12 @@ Go is a drop-in URL shortening service. It aims to provide an easily ...@@ -6,12 +6,12 @@ Go is a drop-in URL shortening service. It aims to provide an easily
branded service for institutions that wish to widely disseminate branded service for institutions that wish to widely disseminate
information without unnecessarily outsourcing branding. information without unnecessarily outsourcing branding.
I encourage you to join the #go channel in SRCT's [Slack Group](srct.slack.com) if you have any questions on setup or would like to contribute. I encourage you to join the #go channel in SRCT's [Slack Group](http://srct.slack.com) if you have any questions on setup or would like to contribute.
## Package Installation ## Package Installation
<legend> <legend></legend>
### Prerequisities ### Prerequisities
First, install python, pip, and git on your system. First, install python and git on your system.
* Python is the programming language used for Django, the web framework used by Go. * Python is the programming language used for Django, the web framework used by Go.
* Git is the version control system used for SRCT projects. * Git is the version control system used for SRCT projects.
...@@ -30,7 +30,7 @@ you install python and git. ...@@ -30,7 +30,7 @@ you install python and git.
### Cloning the Go Codebase ### Cloning the Go Codebase
Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](http://git.gmu.edu/srct/go), the SRCT code respository. Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](http://git.gmu.edu/srct/go), the SRCT code respository.
Configure your ssh keys by following the directions at [git.gmu.edu/help/ssh/README](git.gmu.edu/help/ssh/README). Configure your ssh keys by following the directions at [git.gmu.edu/help/ssh/README](http://git.gmu.edu/help/ssh/README).
Now, on your computer, navigate to the directory in which you want to download the project (perhaps one called development/ or something similar), and run Now, on your computer, navigate to the directory in which you want to download the project (perhaps one called development/ or something similar), and run
...@@ -64,13 +64,22 @@ And that's it! Navigate to [localhost](http://127.0.0.1:8000) in your web browse ...@@ -64,13 +64,22 @@ And that's it! Navigate to [localhost](http://127.0.0.1:8000) in your web browse
### Additional Notes ### Additional Notes
The authentication service used for Go is CAS however in local development all you need to do to sign in is pass your CAS username in both the username and password fields when prompted. The authentication service used for Go is CAS. In local development however we utilize a test server. You can log in using your CAS username for both the username and password fields.
The default superuser is _dhaynes3_ though this can be changed in _vagrantfile_ if you wish. You can run `$ vagrant provision` to apply this change. Be sure not to include that change in your commits.
For a currently undetermined reason at some points if you try to navigate to [localhost](http://127.0.0.1:8000) and you see an error like: "Conenction has been reset" then:
1. `vagrant ssh`
2. `sudo /etc/init.d/networking restart` and then `exit`
3. `vagrant provision` (may need to do twice)
If you make any changes to _models.py_ you will need to re-provision the vm: This is the only temporary fix that we know exists.
If you make any changes to _models.py_ you will need to re-provision the vm's database:
`$ vagrant provision` `$ vagrant provision`
Please note that this will refresh the database. Please note that this will refresh the database (as in delete everything in it).
It is also good practice to shutdown your vm when you are done: It is also good practice to shutdown your vm when you are done:
...@@ -80,8 +89,8 @@ and to restart with: ...@@ -80,8 +89,8 @@ and to restart with:
`$ vagrant up` `$ vagrant up`
## On Deployemnt ## On Deployment
<legend> <legend></legend>
### Deploying with Vagrant ### Deploying with Vagrant
TODO TODO
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment