forked from arjunkomath/Simple-Q-A-App-using-Python-Django
-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Cristian Vargas
committed
May 30, 2016
1 parent
5cb8b9e
commit 95675bb
Showing
1 changed file
with
50 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,58 @@ | ||
# Welcome to django-qa | ||
**WELCOME TO DJANGO-QA** | ||
========================= | ||
## A Simple Q&A App using Python Django | ||
|
||
[django-qa](http://swappsco.github.io/django-qa/) is a fork from [Simple-Q-A-App-using-Python-Django](http://arjunkomath.github.io/Simple-Q-A-App-using-Python-Django) aimed to create a pluggable package than allows to implement a StackOverflow-like forum site for your Django web project. | ||
The development of this package is kindly supported by [SWAPPS](https://www.swapps.co/) and constantly developed by it's colaborators. Feel free to use it, add some issues if you find bugs or think of a really cool feature, even clone it and generate a pull requests to incorporate those cool features made by yourself; If you have special requirements, [drop us a few lines](https://www.swapps.co/) and perhaps we can help you out too. | ||
|
||
The development of this package is kindly supported by [SWAPPS](https://www.swapps.co/) and constantly developed by it's colaborators. Feel free to use it, add some issues if you find bugs or think of a really cool feature, even clone it and generate a pull requests to incorporate those cool features made by yourself; and if you have special requirements, [drop us a few lines](https://www.swapps.co/) and perhaps we can help you out too. | ||
This application is still under active development and we cannot guarantee that nothing will break between versions. Most of the core features are already there, so we expect to release a beta version soon. | ||
|
||
## This is how it looks | ||
## Screenshots | ||
## Features | ||
|
||
Home Page: | ||
<img src="https://raw.githubusercontent.com/swappsco/django-qa/master/qa/static/qa/qa_index.jpeg" /> | ||
* Assumes nothing about the rest of your application. | ||
* Create questions and answers. | ||
* Comment on questions and answers. | ||
* Upvote/Downvote questions and answers. | ||
* Users have a reputation and a profile. | ||
* Support for tagging questions with django-taggit. | ||
* Questions are categorized by latest, popular and most voted. | ||
|
||
QA Page: | ||
<img src="https://raw.githubusercontent.com/swappsco/django-qa/master/qa/static/qa/qa_page.jpeg" /> | ||
## Installation | ||
Django-QA aims at keeping things simple. To install it you have to do what you would do with most django apps. | ||
|
||
This django package is provided under the the MIT license, for more information please refer to the [license](https://github.com/swappsco/django-qa/blob/master/LICENSE.md) file. | ||
Install with pip: | ||
``` | ||
pip install django-qa` | ||
``` | ||
|
||
Add to INSTALLED_APPS in your project settings. | ||
```python | ||
INSTALLED_APPS = ( | ||
... | ||
qa, | ||
... | ||
) | ||
``` | ||
|
||
Add our urls to the project: | ||
```python | ||
urlpatterns = patterns( | ||
..., | ||
url(r'^', include('qa.urls')), | ||
... | ||
) | ||
``` | ||
|
||
Run migrations: | ||
``` | ||
python manage.py migrate | ||
``` | ||
|
||
And that's it! | ||
|
||
## Next steps | ||
With this setup you will have a functional questions and answers section inside of your project. Probably you will need to work on changing the default templates to fit the look and feel of your site. | ||
|
||
If your project has an user profile already, you may want to merge it with the data provided by this app (questions, answers, comments, reputation, etc). That requires some extra work, but can be done without using ugly hacks. | ||
|
||
If you think that something essential for this kind of application is missing, you can request a feature by adding an issue to our repository. |