Commit 0335c81a authored by Tyler Hallada's avatar Tyler Hallada
Browse files

Update README to be more accurate

parent d7121ef2
...@@ -25,22 +25,21 @@ To get started, you'll need the following installed: ...@@ -25,22 +25,21 @@ To get started, you'll need the following installed:
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git) * [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)
* [virtualenv](http://www.virtualenv.org/en/latest/index.html#installation) * [virtualenv](http://www.virtualenv.org/en/latest/index.html#installation)
(to install you will need either (to install you will need either
[pip](http://www.pip-installer.org/en/latest/installing.html) or [pip](http://www.pip-installer.org/en/latest/installing.html)
easyinstall, which is bundled with
[setuptools](http://pypi.python.org/pypi/setuptools)
You don't need to do anything with [git.gmu.edu](https://git.gmu.edu/) to <!--This section is redundant as git.gmu.edu is no longer operational -->
preform a `git clone`, but you should log in if you plan on actually modifying <!--You don't need to do anything with [git.gmu.edu](https://git.gmu.edu/) to -->
code. Logging into git.gmu.edu with your George Mason credentials will create <!--preform a `git clone`, but you should log in if you plan on actually modifying -->
an account. Ask a SRCT member to add you to the SRCT group on the site and you <!--code. Logging into git.gmu.edu with your George Mason credentials will create -->
will be added to the list of people allowed to `git push` to the repository at <!--an account. Ask a SRCT member to add you to the SRCT group on the site and you -->
git.gmu.edu. <!--will be added to the list of people allowed to `git push` to the repository at -->
<!--git.gmu.edu. -->
Then type the following commands in your terminal (if you're on Windows, Then type the following commands in your terminal (if you're on Windows,
[Cygwin](http://www.cygwin.com/) is recommended). [Cygwin](http://www.cygwin.com/) is recommended).
```bash ```bash
git clone git://git.gmu.edu/whats-open/whats-open.git git clone https://github.com/thallada/whats-open.git
cd whats-open/ cd whats-open/
virtualenv venv --distribute virtualenv venv --distribute
source venv/bin/activate source venv/bin/activate
...@@ -49,8 +48,12 @@ python manage.py syncdb ...@@ -49,8 +48,12 @@ python manage.py syncdb
python manage.py migrate website python manage.py migrate website
``` ```
If git.gmu.edu is not loading correctly the alternative url is: <!--This section is redundant as git.gmu.edu is no longer operational -->
https://github.com/thallada/whats-open.git <!--If git.gmu.edu is not loading correctly the alternative url is: -->
<!--https://github.com/thallada/whats-open.git-->
Note, I will have to add you as a collaborator to the github repo for you to be
able to push code. Please email me, Facebook message, or Humbug message me so I
can add you.
###Running the Site Locally### ###Running the Site Locally###
...@@ -60,10 +63,11 @@ Now that everything is set-up you can run the server on your computer. ...@@ -60,10 +63,11 @@ Now that everything is set-up you can run the server on your computer.
python manage.py runserver python manage.py runserver
``` ```
Go to http://127.0.0.1/ in your browser and you should see the website. Go to http://127.0.0.1:8000/ in your browser and you should see the website.
Though, there won't be any restaurants showing. You will need to add them to Though, there won't be any restaurants showing. You will need to add them to
the database. Go to http://127.0.0.1/admin/ to add new Restaurant and Schedule the database. Go to http://127.0.0.1:8000/admin/ to add new Restaurant and Schedule
objects to your database. objects to your database (the login would be the same username and password you
entered when creating a superuser during the `python manage.py syncdb` command).
###Modifying and Deploying Code### ###Modifying and Deploying Code###
...@@ -80,8 +84,14 @@ documentation](http://docs.jquery.com/) and I've found [Mozilla's documentation ...@@ -80,8 +84,14 @@ documentation](http://docs.jquery.com/) and I've found [Mozilla's documentation
on JavaScript](https://developer.mozilla.org/en-US/docs/JavaScript) to be on JavaScript](https://developer.mozilla.org/en-US/docs/JavaScript) to be
useful as well. But if you're Google-fu is sharp, that should suffice. useful as well. But if you're Google-fu is sharp, that should suffice.
If you followed the steps in "Set Up" above, once you actually make changes it <!--This section is incorrect as git.gmu.edu is no longer operational -->
should be easy to push them to the git repository. <!--If you followed the steps in "Set Up" above, once you actually make changes it-->
<!--should be easy to push them to the git repository.-->
Once you actually make your changes and have fully tested them you can push the
code to the git repository. Note, I will have to add you to my github repo in
order for you to be allowed to push code to the repo. Please email, Facebook
message, Humbug message me so I can add you.
There are many ways to use git, and this is one example: There are many ways to use git, and this is one example:
...@@ -100,19 +110,20 @@ Some more helpful links on how to use Git: ...@@ -100,19 +110,20 @@ Some more helpful links on how to use Git:
We currently don't have What's Open running on a dedicated server yet, but when We currently don't have What's Open running on a dedicated server yet, but when
we do I will have instructions on how to deploy the code here. we do I will have instructions on how to deploy the code here.
###Running Site Locally with Production Database### <!--No longer relevant as there is no postgres database set up at the moment-->
<!--###Running Site Locally with Production Database###-->
It is possible to run the site locally using the PostgresSQL database that <!--It is possible to run the site locally using the PostgresSQL database that-->
whatsopen.gmu.edu uses. The way settings.py is configured requires that you set <!--whatsopen.gmu.edu uses. The way settings.py is configured requires that you set-->
an environmental variable to the database's url before you run the site. Talk <!--an environmental variable to the database's url before you run the site. Talk -->
to me if you would like to know the url to accomplish this. <!--to me if you would like to know the url to accomplish this.-->
###To Do### ###To Do###
* Get all restaurants displaying correct open times on the page. AKA. make * Get all restaurants displaying correct open times on the page. AKA. make
extensive tests. extensive tests.
* Add a Typeahead search box at the top to quickly filter out restaurants. * Add a Typeahead search box at the top to quickly filter out restaurants.
* Sort by location view * Sort by location view
* Get a decent UI * Get a decent UI
* Get a usable admin interface UI, currently it is very confusing to add a
restaurant and schedule.
* Add times until opening/closing for restaurants that are close, and exact * Add times until opening/closing for restaurants that are close, and exact
times for those that aren't. times for those that aren't.
* Add yellow close-to-closing condition. * Add yellow close-to-closing condition.
......
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