Post Reader

Post Reader is a Github project/repository that can be forked to deploy and host a website that aggregates user submitted hyperlinks ("posts"), for your specific topic, to Github Pages. Anyone with a GitHub account that creates a Pull Request can contribute content to the website.

It also includes an integration into an AI-driven content summariser for those instances where contributors omit certain meta content or summaries.

The source repository (this one), includes a few example posts related to Angular, the framework this repository was built with. These examples can be viewed at this repository's Github Page.

How to submit your Post

Before submitting your first post, scroll down to the Before making your first contribution section.

Creating a new Post

1. Go to the Post Template Page
2. Copy the template using the Copy raw file button located in the File Preview toolbar
3. Click the + (Add file) button in the Files sidebar on the left
4. Paste the template content

Adding your Content

5. Optionally, insert a Title tag. (A title will automatically be extracted from the original content if omitted)
6. Insert one or more Tags tags, to ensure your content is categorised accordingly
7. Most importantly, insert the hyperlink into the Link tag using the format in the example.
8. Optionally, insert an Image tag. This will be used as a thumbnail on the website post feed. (An image will automatically be extracted for use as a thumbnail, from the original content if omitted)
9. Below the meta section (starting and ending with ---) you are able to add a summary for your post using Markdown syntax. (A summary will automatically be extracted from the original content if omitted)

---
[//]:# (Title: My title)
[//]:# (Tags: #my, #tags)
[//]:# (Link: https://my-example.com)
[//]:# (Image: https://www.btselem.org/sites/default/files/styles/huge/public/2024-08/wth-cover-en_0.png)
---

# My Example header

My example summary goes here. Lorem Ipsum dolor sit amet ...

Example template

Please note: certain websites prevents web scrapers from reading their content. In such situations metadata defined above might not be extractable. Websites known to prevent web scraping are listed in the Websites known to prevent Web Scraping section.

Submitting your Post

10. Use the Commit button to progress to the next step
11. If prompted, optionally add a commit message
12. From the two options presented, to commit directly or to create a Pull Request, select the Pull Request option
13. Finally confirm your commit to submit your post
14. A member of the approval committee will now receive your submission and approve it for display on the website

Before making your First Contribution

Create a Github Account if you don't have one yet and return to this page. This step does not have to be repeated after creating your account.

Websites known to prevent Web Scraping

1.  

How to use this Github Repository to create your own Hyperlink Post site

Select your hosting and deployment method

Github Pages

By default, for any commits made to the main branch of your new repository, a deployment to Github Pages will triggered using Github Workflows.

Configure your Custom Domain to allow your website to display on your pre-registered domain of choice.

To disable Github Pages deployments, delete the file .github/workflows/npm-publish-github-packages.yml

Via Terraform

A sample set of terraform scripts can be found at the /terraform location. The sample terraform scripts are configured to deploy to AWS. Update and use as per your cloud provider and CI/CD framework accordingly.

See Other section below as well.

Other

When setting up your own build and continuous integration pipelines, please note this application uses a custom npm command. Use npm run build-with-content to build your application.

Fork the application

1. Go to rapidapi.com and create an account
2. Go to the TLDRThis API and subscribe to it
3. Copy your X-RapidAPI-key
4. Copy the URL found in the Code snippets section (with the trailing slash)
5. Fork the project to a new public repository
6. Go to the forked repo's Settings page
7. Go to Secrets and Variables >> Actions
8. To the repository secrets add the SUMMARISEAPI secret
9. Also add the SUMMARISEAPIKEY you copied at step (3)
10. Go to Actions >> General and enable Github Actions
11. Go to Pages and for the Build and deployment >> Source setting, select Github Actions
12. Ensure necessary Pull Request and Commit permissions are set up to allow for post approvals by the administrator and/or moderators
13. Change the title at the top of this markdown file (# Post Reader)
14. Change the two intro paragraphs at the top of this markdown file, to reflect the topic and purpose of your own website.
15. In the file located at src/app/app.config.ts change the site title on line 24
16. Remove the example posts in the src/content folder
17. See Base Path Management below
18. Submit and commit your first post

Base Path Management

Due to this repository defaulting to Github Pages, there is a deployment step in the NPM tasks in the package.json file to include a base path in the build step. Depending on your hosting selection you will have to make one of the following changes

Github Pages (without custom domain)

Go to the package.json file, line 13, and replace /post-reader/ with the base path associated with your Github Pages page

Github Pages (with custom domain) and others

Depending on your hosting/website configuration, go to the package.json file and update line 13 as required. Likely you have to remove the --base-href argument

Things to do

• Better Youtube scraping
• Process relative image url's correctly
• Launch page on AI toggle
• Persist toggle preference
• Display multiple columns on larger screen sizes