https://github.com/cfpb/collab

Collab is a Django project with a standard set of configurations to provide services to reusable apps.
https://github.com/cfpb/collab

Last synced: about 1 month ago
JSON representation

Collab is a Django project with a standard set of configurations to provide services to reusable apps.

• Host: GitHub
• URL: https://github.com/cfpb/collab
• Owner: cfpb
• License: cc0-1.0
• Created: 2014-01-16T15:05:50.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-04-13T12:24:09.000Z (over 4 years ago)
• Last Synced: 2024-11-06T18:46:10.369Z (2 months ago)
• Language: Python
• Homepage: http://cfpb.github.io/collab
• Size: 1.69 MB
• Stars: 79
• Watchers: 33
• Forks: 37
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING.txt

Awesome Lists containing this project

README

        
# Collab

[![Build Status](https://travis-ci.org/cfpb/collab.svg)](https://travis-ci.org/cfpb/collab)

## What is Collab?

Collab is a [Django](https://www.djangoproject.com/) project with a standard set of configurations to provide services to reusable apps.

## What is included?

Core Collab comes with:

* Tagging (using a customized version of [django-taggit](https://github.com/alex/django-taggit))

* Notifications

* Search (using [Haystack](http://haystacksearch.org/) and [Elasticsearch](http://www.elasticsearch.org/))

* Migrations (using [South](http://south.readthedocs.org/en/latest/))

* [jQuery](https://jquery.org/)

* Improved Caching

## Setting up a development environment

Requirements:

- Python (>= 2.6)

- Mysql

Follow these steps to set up collab:

1. Clone this repo or a fork of it

   ```bash

   git clone https://github.com/cfpb/collab.git

   cd collab

   ```

1. Make sure you have `pip` and `virtualenv` installed:

   ```bash

   easy_install -U pip

   pip install -U pip

   pip install -U virtualenv

   ```

   You may have to prepend these commands with `sudo`, depending on your setup.

1. Create a virtual environment for the project and install the necessary packages:

   ```bash

   virtualenv --no-site-packages --distribute venv    # creates the virtualenv named "venv"

   source venv/bin/activate                           # activates (places you in) the virtualenv

   pip install -r requirements.txt                    # installs main required packages for collab

   pip install -r requirements-test.txt               # installs packages required for testing

   ```

   _**Important Note:** Anytime you restart your terminal and return to work on this project, you will need to 

   reactivate the virtualenv by running the `source venv/bin/activate` command from the collab root. See 

   [virtualenv](http://pypi.python.org/pypi/virtualenv) for more details._

1. Copy `collab/local_settings_template.py` to `collab/local_settings.py` and edit to match your current 

   environment. In particular, update the `DATABASES` information. You will need to create the database you choose 

   for the default schema.

   * Edit `DATABASES` (in the `else` block) to set the database user and password to whatever user you have set up 

     in MySQL (probably `root` with no password, since it's local to your machine).

   * Set a `SECRET KEY`. This can be any string you want.

   * If you have already set up any other child apps besides the four required, uncomment them in `INSTALLED_APPS`.

1. Set up the database:

   ```bash

   mysql.server start

   mysql -u  -e 'create database collab'

   python ./manage.py syncdb

   python ./manage.py syncdb --noinput --migrate

   python ./manage.py loaddata core/fixtures/core-test-fixtures.json

   ```

   Optionally, you can create random users for local testing.

   ```bash

   python ./manage.py create_users 

   ```

1. Run the Django server:

   ```bash

   python ./manage.py runserver

   ```

1. Go to  in your browser and log in with user `[email protected]` and password `1`.

1. You are a winner!

## Testing

To run tests:

```

python manage.py test

```

Models should have a robust set of unit tests.

When writing unit tests for models, try to separate functionality which needs the DB from functionality which does 

not. Aim to avoid hitting the DB in a test for optimal results.

Views should have unit testing for functional parts of them: that is, try to extract functionality without side effects from the view functions, and then test those extracted functions.

Views should have system testing using [WebTest](http://pypi.python.org/pypi/django-webtest) for page interaction.