Youdecide

Description

Youdecide is a Social Network polling platform.

Installation

Clone the repository and create a Virtual Environment.
- Run virtualenv <virtualenvname> to create the virtual environment or mkvirtualenv <virtualenvname> if using virtualenv wrapper to create the virtual environment.
Install all the necessary requirements by running pip install -r requirements.txt within the virtual environment.

Configure your database configurations in a development.py and save in the settings folder (sample shown below) You'll need to install postgres for this. If you don't have it installed, download it here.

Sample development.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

from .base import *
import sys

if 'test' in sys.argv:
    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.sqlite3',
            'NAME': 'testdatabase',
        }
    }
else:
    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.mysql',
            'NAME': 'youdecide', # Enter your database's name
            'USER': 'user', # Enter your DB user
            'PASSWORD': 'p@ssw0rd', # Enter your DB password
            'HOST': 'localhost',
            'PORT': '3306',
        }
    }

If you prefer another 3rd party DB backend update the second 'ENGINE' value accordingly

Create a .env.yml to hold all your environment variables, like your secret key, save in the same level as your README.md file (sample shown below)

Sample .env.yml format

api_key:
"123456789101112"  # This is your API key
api_secret:
"Abc_DefgHIjKlmn-O1pqRStu2V"  # This is your API secret
cloud_name:
"youdecidefile"
SECRET_KEY:
"12345678910111213141516171819202122232425"  # This is the Secret key
sendgrid_apikey:
"1234567891011121314151617181920212223242526272829303132333435"  # This is your SendGrid API Key
GITHUB_CLIENT_ID:
    "123456789101112131415"  # This is your Github client ID
GITHUB_SECRET_KEY:
    "12345678910111213141516171819202122232425"  # This is your Github secret Key
CELERY_NOTIFICATION_TIMEOUT:
    "10"  # This is the timeout set to 10 seconds (Increase this parameter for production)

Run npm install to install all front end dependencies. Please ensure you are on the same level with .bowerrc when you run this command
Run cd youdecide to navigate into the project directory
Run python manage.py collectstatic to copy all your static files into the staticfiles directory
Run python manage.py makemigrations and python manage.py migrate to create the necessary tables and everything required to run the application.
Run python manage.py runserver to run the app.
Run coverage run manage.py test to know how much the app is covered by automated testing.
Run coverage report to view the report of the coverage on your terminal.
Run coverage html to produce the html of coverage result.

Running tests

Activate virtual environment.
Navigate into the project directory.
Run python manage.py test to test codango.
Run python manage.py test <appname> to test an individual app.
Run coverage run manage.py test to run coverage for codango.

REST API

Youdecide has a Representational State Transfer (REST) Application Program Interface (API) The documentation done on Apiary is here.

The API endpoints are accessible at localhost:8000/api/v1/

To run tests specific to the API Run python manage.py test api pip install mysqlclient

pip install pymysql Then, edit the init.py file in your project origin dir(the same as settings.py)

add:

import pymysql

pymysql.install_as_MySQLdb()

run app

edit wsgi.py os.environ.setdefault("DJANGO_SETTINGS_MODULE", "youdecide.settings.SPECIFIC_SETTINGS_NAME") eg os.environ.setdefault("DJANGO_SETTINGS_MODULE", "youdecide.settings.local") python manage.py runserver --settings=youdecide.settings.['local' or 'production' or 'test' etc]

Copyright

Install ngrok

run the command below for testing with different machines ngrok http 8080 -host-header="localhost:8080"

SOCIAL OAUTH LOGIN

-Now go to django admin, click on the social application table and add a new Application. -client_id and client_secret shouldn't be changed -user should be your superuser -redirect_uris should be left blank -client_type should be set to confidential -authorization_grant_type should be set to 'Resource owner password-based' -name can be set to whatever you want

You can test by running this command

curl -X POST -d "grant_type=convert_token&client_id=<client_id>&client_secret=<client_secret>&backend=facebook&token=<facebook_token>" https://youdecide.herokuapp.com/api/v1/account/auth/convert-token/

This request returns the "access_token" that you should use on all HTTP requests to any of the endpoints . What is happening here is that we are converting a third-party access token (<user_access_token>) in an access token to use with the application api and its clients ("access_token"). You should use this token on each request to any of the api endpoint to authenticate each request and avoid authenticating with FB/ or any other platforms every time.

How to vote an anynonmous user

Make a request to the endpoint with this curl format

curl --header "Content-Type: application/json" -d '{"choice": "1", "poll": "1", "email":"somemail@ymail.com", "phone_number": "08106125357"}' https://youdecide-io.herokuapp.com/api/v1/polls/1/choices/1/vote/

Elastic Search

Query param name reserved for search is search.

Search in all fields (question, pub_date, user) for word “question”.

curl --header "Content-Type: application/json" -X GET http://youdecide-io.herokuapp.com/api/v1/polls/search/?search=pitbull

Search a single term on specific field

In order to search in specific field (question) for term “how to become a developer”, add the field question separated with | to the search term.

curl --header "Content-Type: application/json" -X GET http://youdecide-io.herokuapp.com/api/v1/polls/search/?search=question|pitbull

Search for multiple terms in specific fields

In order to search for multiple terms “how to become a developer”, and the with the pub_date, in specific fields add multiple search query params and field names separated with | to each of the search terms.

http://youdecide-io.herokuapp.com/search/publisher/?search=question|pitbull&search=pub_date|

CELERY TASK QUEUE

Please install redis on your local machine and start the redis server, once done please follow this steps below

Navigate into the project directory.
Run celery -A tasks worker --loglevel=info to start a Celery worker service.
Run celery -A tasks beat -l info -S django> as a separate process, start the beat service .

rossi1/Youdecide-Backend