refact0r / alpine

A clean browser startpage with weather and stock market widgets.
Apache License 2.0
60 stars 6 forks source link
new-tab newtab newtabpage start-page startpage startpages

alpine

A clean browser startpage with weather and stock market widgets.

features

image

my firefox css: https://github.com/refact0r/sidefox

matching firefox color theme: firefox color

usage

firefox installation

  1. download the .xpi extension file from the latest release
  2. go to about:addons in firefox, click the gear icon in the top right
  3. click "Install Add-on from File" and select the .xpi file

chrome installation

  1. clone the repo
  2. delete this section from public/manifest.json:
"chrome_settings_overrides": {
    "homepage": "index.html"
},
  1. run npm install
  2. run npm run build, you should see it create a folder called /dist
  3. go to chrome://extensions/ in chrome and enable developer mode in the top right
  4. click "Load Unpacked" in the top left and select the /dist folder

enabling weather and stocks

  1. create an account at https://openweathermap.org/api
  2. get your weather API key at https://home.openweathermap.org/api_keys
  3. create an account for Alpaca or FinancialModelingPrep

    using Alpaca will get % changes for the 9 stocks specified in the config, while using FinancialModelingPrep will get the 9 most active stocks of the day

  4. get your Alpaca key and secret (far right) or FinancialModelingPrep API key
  5. open alpine and click in the bottom right to open the config editor
  6. paste your api keys into the corresponding spots on the config, make sure to change stocks.source to fmp if using FinancialModelingPrep
  7. you can also edit settings like weather location, links, and stocks

build from source

environment requirements:

node: >=14.18.0
npm: >=8.0.0
  1. run npm install
  2. run npm run build
  3. the generated code should appear in /dist