first commit

README.md

@@ -0,0 +1,61 @@
+# Baraveli News
+
+Discover Stoes,Daily news and inspiration for maldivian readers.
+
+
+
+Single article should be routed by the given matching
+
+<code>/article/[article:uuid]</code> The unqiue primary key for a scraped article should be a UUID.
+
+
+
+## Bots
+
+Baraveli News bots pushes any new news aggregated from the scrapers to any given notification channel. Mostly for telegram.
+
+
+
+### Web
+
+List of the things to be present and aggregated in home page
+
+<u>**Today's Pick**</u>
+
+This will be 6 random articles from different sources that occured in today. This could be randomly ordered or aggregated based on a certain factor
+
+
+
+<u>**Discover Topics**</u>
+
+List of popular topics,categories or tags that are discussed with in articles. When clicked it should aggregate and display only the articles matching those topics.
+
+Url for this can be constructed like so: <code> /topic/[topic:slug] </code>Topics will be routed by the slug.
+
+
+
+<u>**Popular Stories**</u>
+
+List of popular articles from the new sites. Paginated with ajax loads stories style.
+
+
+
+**<u>Recent Stories</u>**
+
+List of all the recently Stories from varies news sites.
+
+
+
+##### SEO Content
+
+<u>**OG Image**</u>
+
+OG image of the given artice should include source logo and article title rendered in dhivehi. All of these renders will be cached for 24 hours or 12.
+
+
+
+**<u>OG Title</u>**
+
+OG Title of the article should contain the english Title of the given article.
+
+