Skip to content
/ AFATS Public

Away From All The Shit (AFATS) [basically designed for myself] is a browser home page / new tab document for people who want a clean, efficient and productive homepage

License

Notifications You must be signed in to change notification settings

cstayyab/AFATS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Away From All The Shit (AFATS)

by cstayyab

Away From All The Shit (AFATS) [basically designed for myself] is a browser home page / new tab document for people who want a clean, efficient and productive homepage that is totally in their control and can be used on all the devices with cross-browser compatibility.

Working

It basically works by the predefined config.json file present in the root directory. The config.json provides the default attributes for the homepage. The default settings can be overidden using the 'Settings' and 'Add Quick Link' interface provided in the footer. It is implemented using HTML5 LocalStorage.

config.json Options

These are the options that can be changed according to your willingness.

title : Title of the page and the main heading that will be displayed on homepage.

description: A small description that will be desplayed below the tagline.

searchEngines: An array representing the a collection search engines. Each element can contaain the following:

    slug: A generic identifier containing only alphanummeric characters.

    title: A user-friendly name of the Search Engine.

    url: The URL of the search page

    queryParam: The query parameter which should contain the search string.

    options(optional): An object conatining key-value pair representing additonal parameters to be passed to the search page.

    faClass(optional): The font-awesome classes as the icon of the search engine. (e.g. "fab fa-google")

defaultEngine: String containing the slug of the search engine you want to make default.

tiles: List of favorite links that will be displayed in form of tiles below the search bar. Following are the fields in each of them:

    slug: A generic identifier for link containing on alphanumeric characters.

    url: URL to the Webpage

    title: Friendly name for the page

    description: Short description of the link

replaceDescriptionWithQuotes: When set true Description with replaced with a new random quote on every page reload

Changelog

February 08, 2020

  • Added enhancement from Issue #4

July 3, 2019

  • Added Support for Reading From HTML LocalStorage

  • Added support for overriding Title, Description and Default Search Engine in LocalStorage

  • Added support for deleting Quick Links

  • Added support for adding new Quick Links

Future Improvements

  • Implementation of LocalStorage to replace the default configuration set by config.json and make it dynamic.

  • Provide an interface on frontend to easily change the parameters in LocalStorage

  • Add Support for Adding new Quick Links

  • Make website available offline using Service Workers

  • Add more search engines

About

Away From All The Shit (AFATS) [basically designed for myself] is a browser home page / new tab document for people who want a clean, efficient and productive homepage

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published