README
Unofficial Quora Widget
Quora widgets for your amazing Quora profile.
With just two lines you can now add snippets of your complete Quora profile into your own personal websites. A little preview
You can also see live version of this card here at Arpit's Blog
Quick Use
Visit: http://codeville.org.in/quora to generate a Quora profile card for yourself.
Or you can copy-paste the lines below in your website.
<script src="http://codeville.org.in/static/js/quora-widget.min.js"></script>
Advanced Usage
You can very much configure this widget to your needs. You need to set and reset some attributes in your div tag.
-
iframe: This option allows you to load the widget in aniframe. If you set this attribute then your complete card will load inside an iframe instead of directly injecting HTML code inside your DOM structure. One big advantage of this is neat styling. Possible values: "yes" and "no" -
widget-width: This option allows you to set the width of the widget to your needs. This only works when youriframeis set toyes -
widget-height: This option allows you to set the height of the widget to your needs. This only works when youriframeis set toyes -
type: This option tells what type of widget to load. Possible values:cardandwidget
card: This is the minimal information about your Quora profile, like
- Your Profile Bio
- Number of answers
- Number of followers
- Various statistics
- Highlights from your profile
FYI: Default width of card is 380px and height of the card depends on your data present in profile. But in case you use iframe attribute the height can be tweaked to the one specified in widget-height.
widget: This feature is under development and should not be used right now. I am to provide following things in this
- All information shown in Quora card.
- Snippets of recent 20 answers you wrote.
If you have any more suggestions on this feel free to create raise an issue here
Ingredients
The mastermind behind is widget is the Quora-Widget API. It does all data fetching from Quora server and generated the HTML code that renders as the widget on a website. Extensive documentation of the API can be found here
Installation
The first step that you should take is
-
Clone the repository
git clone --recursive https://github.com/arpitbbhayani/quora-widget.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 fromquora-widgetfolderbash 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 thestart.shscript that starts the web server. All you need to do is run it fromquora-widget-apifolder
bash start.sh
- 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
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.
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]
Issues
If you find any issue or have any feature request, feel free to create an Github Issue for it.