Quirell

Quirell

CollectQT builds a social network for your friends ^_^

Quirell


About

Quirell is a currently in developement social network being developed by CollectQT. The core feature of Quirell is that its driven by the unique and varied relationships between people in diverse communities. We want to create an online platform that allows for an accurate representation of the ways you relate to people, while also promoting a safe and comfortable space.

Feature wise, Quirell takes a lot of cues from Facebook and Tumblr, and technically it is inspired by rstat.us and diaspora*

Quick start

Only works on Ubuntu, and only tested on Ubuntu 14.04. Any other system will need to follow the long form instructions

git clone http://gitlab.com/collectqt/quirell.git
cd quirell
bash bin/install
bash bin/start
python quirell

Go to http://localhost:5000 in your browser

Slightly less quick

Create a gitlab account and clone quirell via https or ssh

Important the install script is written for Ubuntu, any other system will need to install the requirements manually. The requirements are:

But if you are on Ubuntu, you can run the following command. Hit enter a few times to keep the default config options, and enter your password as needed.

bash bin/install

The install includes a section which activates the environment, but if you are running the code for a 2nd or 3rd time you'll have to activate the environment yourself

bash bin/activate

Start the required databases. This assumes that you aren't using custom ports or remote resources. If you are you'll have to add their location to ENV.yaml

bash bin/start

Finally, you can run the code with

python quirell

At this point you should be able to go to http://localhost:5000 in your browser and view Quirell !

When you are done working on things you probably want to turn off the local databases services, do that with

bash bin/stop

Contributing

Anything you would ever want to help with is on the gitlab issues list. Although you probably want to look at the standalone issues, they're picked to be issues that one could easily work on without requiring a ton of knowable about the code base.

Try not to push to develop if your changes make the tests fail! This command will run tests for you

py.test

Also if you have push access, the relevant git remotes are:

git remote add origin git@gitlab.com:collectqt/quirell.git
git remote add github git@github.com:CollectQT/quirell.git
git remote add heroku git@heroku.com:quirell.git