Metadata-Version: 2.1
Name: django-simplefeedback
Version: 0.7.1
Summary: A simple Django app to handle user tickets.
Home-page: https://www.github.com/pulilab/django-simple-feedback
Author: Zoltan Ilcsik
Author-email: zi@pulilab.com
License: BSD License
Description: # Installation
        
        Install the pip package:
        
        ```bash
        pip install django-simplefeedback
        ```
        
        Install `django-rest-framework` if not already installed
        
        add `simple-feedback` and `rest_framework` to INSTALLED_APPS
        
        include 'simple-feedback.urls' into urlpatterns
        
        ```python
        from django.conf.urls import url, include
        from django.contrib import admin
        
        urlpatterns = [
            url(r'^admin/', admin.site.urls),
            url(r"^api/", include("simple-feedback.urls")),
        ]
        ```
        
        Migrate the db to crate simple-feedback models
        
        ```bash
        python manage.py migrate
        ```
        
        # Develop
        
        Clone the repo
        
        ```bash
        git clone git@github.com:pulilab/django-simple-feedback.git
        ```
        
        ## Test app
        
        Test standalone app:
        
        $ export DATABASE_URL='your_db'  # you can skip this, defaults to 'localhost' (use postgres.app for simplicity)
        
        $ pip install -r requirements.txt
        
        $ python runtests.py
        
        ## Run the app in develop mode
        
        Create a new django project and install the package in develop mode
        
        ```bash
        django-admin startproject simple_feedback_demo
        cd simple_feedback_demo
        pip install -e ~LOCAL_PATH_TO_DJANGO_SIMPLEFEEDBACK
        ```
        
        Add `simple-feedback` and `rest_framework` to `INSTALLED_APPS` in `settings.py`
        
        ```python
        INSTALLED_APPS = [
            'django.contrib.admin',
            'django.contrib.auth',
            'django.contrib.contenttypes',
            'django.contrib.sessions',
            'django.contrib.messages',
            'django.contrib.staticfiles',
            'rest_framework',
            'simple-feedback'
        ]
        ```
        Configure demo app urls
        
        ```python
        from django.conf.urls import url, include
        from django.contrib import admin
        
        urlpatterns = [
            url(r'^admin/', admin.site.urls),
            url(r"^api/", include("simple-feedback.urls")),
        ]
        ```
        > SqlLite is not supported
        
        Change the db config to use postgres in `settings.py`:
        
        ```python
        DATABASES = {
            'default': {
                'ENGINE': 'django.db.backends.postgresql_psycopg2',
                'NAME': 'postgres',
                'USER': 'postgres',
                'HOST': os.environ.get("DATABASE_URL", 'localhost'),
                'PORT': 5432,
            }
        }
        ```
        
        Migrate db, create super user and run your demo app:
        
        ```bash
        python manage.py migrate
        python manage.py createsuperuser
        python manage.py runserver
        ```
        
        open the browser at `http://localhost:8000/admin`
        
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
