quora-widget-api

This API is the mastermind of Quora-Widget. It does all data fetching from Quora server and generated the HTML code that renders as the Quora Card on a website.

Ingredients

Python: This API is written in Python and have no backend whatsoever.
Flask: The web framework used for exposing API is Flask. And to make code modular, some flask extensions are used.
HTML/CSS: To make things beautiful HTML/CSS plays the most important role.

Installation

The first step that you should take is

Clone the repository

git clone https://github.com/arpitbbhayani/quora-widget-api.git

Execute the script install.sh
I have written a small script that setups virtual environment for Python and installs every package required for the execution. You simply need to execute the script from quora-widget-api folder
```
bash install.sh
```

Hello World!

Once you have installed everything, it is time to check if eveything is set or not. This is how you will you do that.

Start the server
Just like a comprehensive installation script, I have also written the start.sh script that starts the web server. All you need to do is run it from quora-widget-api folder

bash start.sh standalone

From your favourite browser just hit the following URL
```
http://localhost:5000/quoracard/
```

You should see a response like this

{
    "message": "Hello world!"
}

If you see this message then ...

Yay! you are now all set to contribute to this project.

Sample Quora Card

To see a sample Quora Widget you can hit this URL from your browser

http://localhost:5000/quoracard/process?url=https://www.quora.com/profile/Arpit-Bhayani

Issues

If you find any issue or have any feature request, feel free to create an Github Issue for it.

Contribute

If you want to contribute, checkout Github Issues and choose any task you want and start working on it and when you think you are done, create a Pull Request for your branch.

In case of any doubt drop me an email at [email protected]

How to submit your patch

Pick an issue
You should first pick an issue from existing Github Issues to work on.
Code!
Once you understand the issue, create your own branch and code! In case you have any query feel free to drop me an email at [email protected]
Submit a Pull Request
Since you have made all changes in your code and you are sure that everything will work fine, simply create a pull request. Once you create a pull request, I will merge it to the master branch after a code review.

README