https://github.com/alcarney/moduleplanner-django
Our attempt at using Django with MongoDB to build a module planner
https://github.com/alcarney/moduleplanner-django
Last synced: 3 months ago
JSON representation
Our attempt at using Django with MongoDB to build a module planner
- Host: GitHub
- URL: https://github.com/alcarney/moduleplanner-django
- Owner: alcarney
- Created: 2014-10-16T15:31:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-13T16:29:30.000Z (over 10 years ago)
- Last Synced: 2025-01-29T22:03:50.359Z (4 months ago)
- Language: Python
- Size: 371 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Module Planner
## Installation
Make sure you have the following installed before continuing:
- git
- python2-pip
- virutalenv
- mongodb
If you haven't done so already clone the repository by running:
```
$ git clone https://github.com/alcarney/moduleplanner-django.git
```
Then ```cd``` into your newly cloned repository and create a new virtual env
```
$ virtualenv env
```
Activate your newly created virtualenv
```
$ source env/bin/activate
```
You can check that this worked by running ```which python ``` which prints to the
shell the filepath of the python binary it should end with
```
path/to/cloned/repo/env/bin/python
```
This next command will then install django and the other python dependencies needed for
this project into your virtualenv
```
$ pip install -r requirements.txt
```
## Running the development server
Once you have everything you need installed and ready to go you can fire up the development server
by navigating to the ```bin``` directory and running
```
$ ./rundevserver.sh
```
__Note:__ Before running this command make sure that the folder ```db/``` exists in
the root of the project otherwsie the database will fail to start.
The above command simply starts the database and the development server, it doesn't
automatically include data. So to get a database including a dataset to work with then
run.
```
$ ./rundevserver.sh --fresh-data
```
__Important:__ The above command deletes whatever is currently in the database and imports
the data stored in /data. It is intended as a "reset button" so that if during development
the data in the database gets messed up we can roll back to a previous clean set.
If any data gets added to the database that you want to keep then make sure it gets added to the
/data folder as well as a backup. This can be done either by manually creating the JSON file yourself
or by making use of the [mongoexport](http://docs.mongodb.org/manual/reference/program/mongoexport/)
command.
# Contributors
- Alex
- Timothy
- Adam
- Vince
- James
- Json
# Tests
## Functional Tests
Functiontional tests are run using [selenium](http://selenium-python.readthedocs.org/).
For a good overview see: [http://chimera.labs.oreilly.com/books/1234000000754/](http://chimera.labs.oreilly.com/books/1234000000754/).
At the moment tests are being developed for Firefox and Chrome.
For them to work you need to have the ChromeDriver executable in your path.
One approach to this is to download from [http://chromedriver.storage.googleapis.com/index.html](http://chromedriver.storage.googleapis.com/index.html) and put the `ChromeDriver` file in a folder like `/usr/local/bin`.
To run the functional tests:
$ python python functional_tests.py
This should open two browser windows: (one in chrome and the other in firefox).
No output on the shell is a good thing.
## Unit Tests