Skip to content

User Manual

Jump to bottom
elffiona edited this page Mar 8, 2021 · 27 revisions

Blogalytics is a blog platform that aims at providing users with text visualization and user behavior analytics.

Have you ever been through the case that you thought the long blog is focusing on the thing you are searching for, but then after scrolling it until the end you still failed to find your point of interest? What a waste of time.

With the form of a word cloud, Blogalytics displays the critical keywords of the blog you selected so that you can decide whether to read the entire post based on your interests on the keywords.

In addition, Blogalytics can display the behavior analytics of the readers of the blogs, so you as writers can gain a better understanding of which points of your blog are attracting the most attention from your audience. This can be a good tool to help with composing your next blog.

Let's get started!

  • Installation help

    Before you start, make sure to download Python In your terminal, type:
    $ git clone https://github.com/cs130-w21/15.git
    $ pip install virtualenv // ignore if you have already installed virtualenv

  • Launch help

    In your terminal, type:
    $ virtualenv 15
    $ source 15/bin/activate
    $ cd 15
    $ pip3 install spacy==2.3.5
    $ pip3 install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.3.0/en_core_web_sm-2.3.0.tar.gz
    $ pip3 install -r requirements.txt
    $ python3 manage.py makemigrations
    $ python3 manage.py migrate
    $ python3 manage.py createsuperuser
    $ python3 manage.py runserver
    Then, in your browser, enter localhost:8000
    You should be able to see a page like the following:
    View_after_lauching Whenever you want to go back to this main home page, click the HOME button at the top of the page.

  • Register

    To register as a new user, click the REGISTER button at the top-right corner, scroll down, and you should be able to see a page like the following:
    Register_form
    After successfully filling up the form, you will be directly direct to the login page.

  • Login

    To better utilize Blogalytics, please kindly log in through the login page.
    You can click on the LOGIN button at the top-right corner of the main home page of Blogalytics.
    Simply try enter your username and password.
    The Login page has the form like the following:
    login
    After logged in, you also have the option to log out.
    Click on the LOGOUT button at the top-right corner of the page.
    The home page you see after logged in should be looking like this:
    logout

  • Post a blog

    On the home page after you logged in, click on the button NEW POST to post a blog.
    You would be direct to a page that looks like the following:
    post_blog Simply just type in your post here and click the POST button!
    And you will be directed to the page of the blog you just posted.

  • View a blog

    To view a certain blog, just click on the title of the blog and you will be directed to the page of the blog.
    After you move your mouse on the title and before you click it, you can see that the title changed color from black to blue.
    view_blog From the above image and a click, you should be able to see the post like this:
    the_blog_page You can also give a "like" to the current post you are viewing by clicking the button LIKE.

  • View the user behavior analytics report

    Within the page of a blog, click on the button GENERATE HEAT MAP.
    Then you should be able to see a colorful view which is indicating the reader behavior of this post.
    Since this is a heat map, red hexagons mean that readers spent relatively more time on these positions, and blue ones mean that readers spent relatively less time on these positions.
    In the example post "Daenerys Targaryen", after clicking the button you should see something like the following: heatmap Notice that the heat map generated for this post when you click the button GENERATE HEAT MAP could be different due to other readers reading this post after this user manual is completed.
    To return to the normal view of the blog without the heat map, just click on the button GENERATE HEAT MAP again.

  • View the word cloud

    Blogalytics supports two different ways to view the word cloud for a certain post:

    1. The first one is viewing the word cloud from the home page/ search result page.
      You can view the word cloud for a certain post by clicking the button SHOW WORD CLOUD that is displayed under the excerpt of each post, and then a small image of the word cloud will be displayed. You can click on the button HIDE WORD CLOUD to choose to hide the word cloud. For the example post "Daenerys Targaryen", you should be able to see this: word_cloud
    2. The second one is viewing the word cloud from the blog page.
      You can view the word cloud for a certain post by clicking the button SEE WORD CLOUD that is displayed under the entire of each post on the page of the blog, and then you will be directed to the image of the word cloud. This display of the image is realtively large.

  • Search for interest

    To search for blogs that correspond to your interest, click on the magnifier button at the top left corner of the home page.
    You should see that you can type in the keyword you want in the space that popped up:
    search After inputting the keyword, hit "ENTER" on the keyboard to view the result of the search.
    It should only display the blogs that contain the keyword.

  • Personal page

    Aside from viewing blogs and posting blogs, Bloglytics also provide users with the functionality of deleting the blog posted by the user.
    By clicking the PROFILE button at the top, you are directed to your own personal page that only displays the blog posted by you.
    You can then manage the blog from this page.
    By clicking on the title of a blog, you will be directed to the blog page in which you can view the word cloud and heat map.
    An example of the personal profile page looks like the following: profile_1 profile_2

Congratulations on finishing the user manual! Have fun exploring our blog platform Blogalytics!

Clone this wiki locally