Feedful is a very opinionated, fast, jamstack rss reader for tech news. A [github action] scrapes rss urls from publications.json file and generates each article as a json file, which is fed to nuxt-content plugin to generate the pages in feedful, once scraped, the files are commited using the same action, which triggers a build in vercel.
TODO.
- Rewrite the scrape function properly, use
Promise.allto run the scraper in parallel. - Add bookmark, share, fullscreen features to the article preview section.
- Add a search feature.
- Add a settings page, dark mode settings, and other settings.
- Move away from hackernews rss and use its api, which is much faster, more updated content, and get data like upvotes etc.
- Add a "read later" feature, integrate with pocket, and other services.
Tech stack
- Nuxt.js for frontend
- Nuxt content module as a cms
- Tailwindcss the css framework
- Vercel for deployment
- Github Actions for generating content
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn dev
# build for production and launch server
$ yarn build
$ yarn start
# generate static project
$ yarn generateFor detailed explanation on how things work, check out the documentation.
You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.
The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.
More information about the usage of this directory in the documentation.
The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.
More information about the usage of this directory in the documentation.
Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.
More information about the usage of this directory in the documentation.
This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.
More information about the usage of this directory in the documentation.
The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.
More information about the usage of this directory in the documentation.
This directory contains your static files. Each file inside this directory is mapped to /.
Example: /static/robots.txt is mapped as /robots.txt.
More information about the usage of this directory in the documentation.
This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.
More information about the usage of this directory in the documentation.