xepozz / blogit Goto Github PK

We need cut functionality that will show the first part of the post and hide the second part.

This is necessary so that people open posts and delve into them on a separated page, not on the page with the list of posts.

I think for the first time we can use just <hr> tag as a delimiter.
It's easy to implement and won't affect original look (in github issue)

Example

First part

***

Second part

What we will see on the page with the list of posts

First part

What we will see on the post's page

First part

---

Second part

• How to use and configure the site
• How to write posts
• Code style rules
• Make tests and other checks (using Github Actions)

There is a long long description :)



















Too long.

I early explain the main problem, see #11.

We need to handle this error with separated component that will contain:

• Short description of the problem
• Show existing ways to solve the problem:
  • Just wait N minutes (need to show remaining minutes)
  • Authorize with github token to raise the limits (see already completed authorization module)

Tech solution:

1. Develop static page with short description (see above)
2. Develop global event handler for rate limits error, that will redirect to error handling component

https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting

It says here ^ that Github has several limits:

1. Limit for unauthorized user by IP 60 requests per hour
2. Limit for authorized user by token: 5000 requests per hour

I have several idea how to avoid the limits:

1. Github API mirror
2. Cache intensity Implemented
3. Proxies
4. Refusing of Github API towards web version

Need to implement garbage collector for cached API requests.

Tech solution:

1. Set GC call at interval every 5 minutes
2. GC should check each stored value and remove expired

Would be nice to have an ability to attach vote to a post.

I have an idea make vote based on emoji laugh, confused, heart, hooray, rocket, eyes

How to implement:
1.Whether or not a vote needs to be taken will be declared using comments.
2. The format of the comment will be as follows:

<!--
<vote>
{
{"emoji": "laugh", "label": "Option label 1"},
{"emoji": "confused", "label": "Option label 2"},
{"emoji": "heart", "label": "Option label 3"},
{"emoji": "hooray", "label": "Option label 4"},
{"emoji": "rocket", "label": "Option label 5"},
{"emoji": "eyes", "label": "Option label 6"}
}
</vote>
-->

This format is not available, because at now blogit uses already processed markdown format (completed html).
Also github markdown processor removes any comments or attributes.
3. After receiving the content of the post, comments should be removed from the view
4. The number of reactions can be obtained from a separate API method.
5. In the voting statistics, you need to display count of votes and the percentage

Artifacts:

• https://developer.github.com/v3/reactions/#list-reactions-for-an-issue
• https://developer.github.com/v3/reactions/#reaction-types

Need to research this possibility.

Need to implement internalisation with multiple languages.

Need to cover each functionality with test.

Unit:

• Tests for raw data => object transformation
  • Post
  • Comment
  • Reactions
  • Vote
• Tests for caching mechanism

Acceptance:

• Posts
  • Posts is loading
  • Single post is loading
  • Comments is loading
  • Likes/Dislikes is loading
• Filtering
  • Filters by tag is working
• Caching is working
• Auth token can be stored

Feature can be realized as in #5 using Issue Reactions as a counters of likes/dislikes

✌ Hi there! ✌️ It's my (@xepozz) first post 🥇

The blog is started.

At now posts may interpreter any markdown entities. We can see these in the next posts.

There is some highlighted snippets:

class User extends \UserInterface
{
    private int $id;
}

const result = [].push('one').push('two');
console.log(result);

ps -aux | grep init > /dev/null

Stay likes, do reposts, click on bells and all links will be in the description 😀

See ya!

There is experiment for using "cut" functionality.

On main page post must not be showed fully.
On main page you should see post before horizontal delimiter.

On view page you can see all of the post.
If you texts as described above then "cut" functionality works.

Would be nice to have an ability write comments and other actions directly on the site.
I see this action plan:

1. Blog should have an possibility to auth an user over github (at now it's available only with usage Secret token)
2. Need to develop the comment form
3. Need to develop preview functionality for comments

There is my first post on Blogit system

I'm very happy 😸